CONTRIBUTING.md 1.65 KB
Newer Older
1
Contributing
2 3
============

4
Thank you for considering contributing to Mastodon 🐘
5

6
You can contribute in the following ways:
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
16

17
Bug reports and feature suggestions can be submitted to [GitHub Issues](https://github.com/tootsuite/mastodon/issues). Please make sure that you are not submitting duplicates, and that a similar report or request has not already been resolved or rejected in the past using the search function. Please also use descriptive, concise titles.
18

19
## Translations
20

21
You can submit translations via pull request.
22

23
## Pull requests
24

25
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.
26

27
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.
28

29
**Pull requests that do not pass automated checks may not be reviewed**. In particular, you need to keep in mind:
30

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

35
## Documentation
36

37
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).