CONTRIBUTING.md 1.83 KB
Newer Older
1
Contributing
Eugen Rochko's avatar
Eugen Rochko committed
2 3
============

4
Thank you for considering contributing to Mastodon 🐘
Eugen Rochko's avatar
Eugen Rochko committed
5

6
You can contribute in the following ways:
Eugen Rochko's avatar
Eugen Rochko committed
7

8 9 10 11
- Finding and reporting bugs
- Translating the Mastodon interface into various languages
- Contributing code to Mastodon by fixing bugs or implementing features
- Improving the documentation
12

13 14
If your contributions are accepted into Mastodon, you can request to be paid through [our OpenCollective](https://opencollective.com/mastodon).

15
## Bug reports
Eugen Rochko's avatar
Eugen Rochko committed
16

sclaire-1's avatar
sclaire-1 committed
17
Bug reports and feature suggestions must use descriptive and concise titles and be submitted to [GitHub Issues](https://github.com/tootsuite/mastodon/issues). Please use the search function to make sure that you are not submitting duplicates, and that a similar report or request has not already been resolved or rejected.
Eugen Rochko's avatar
Eugen Rochko committed
18

19
## Translations
Eugen Rochko's avatar
Eugen Rochko committed
20

21 22
You can submit translations via [Crowdin](https://crowdin.com/project/mastodon). They are periodically merged into the codebase.

23
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/mastodon/localized.svg)](https://crowdin.com/project/mastodon)
Eugen Rochko's avatar
Eugen Rochko committed
24

25
## Pull requests
Eugen Rochko's avatar
Eugen Rochko committed
26

27
Please use clean, concise titles for your pull requests. We use commit squashing, so the final commit in the master branch will carry the title of the pull request.
Eugen Rochko's avatar
Eugen Rochko committed
28

29
The smaller the set of changes in the pull request is, the quicker it can be reviewed and merged. Splitting tasks into multiple smaller pull requests is often preferable.
Eugen Rochko's avatar
Eugen Rochko committed
30

31
**Pull requests that do not pass automated checks may not be reviewed**. In particular, you need to keep in mind:
Eugen Rochko's avatar
Eugen Rochko committed
32

33 34 35
- Unit and integration tests (rspec, jest)
- Code style rules (rubocop, eslint)
- Normalization of locale files (i18n-tasks)
36

37
## Documentation
38

39
The [Mastodon documentation](https://docs.joinmastodon.org) is a statically generated site. You can [submit merge requests to mastodon/docs](https://source.joinmastodon.org/mastodon/docs).