CONTRIBUTING.md

   1 Contributing
   2 ============
   3
   4 Thank you for considering contributing to Mastodon 🐘
   5
   6 You can contribute in the following ways:
   7
   8 - Finding and reporting bugs
   9 - Translating the Mastodon interface into various languages
  10 - Contributing code to Mastodon by fixing bugs or implementing features
  11 - Improving the documentation
  12
  13 If your contributions are accepted into Mastodon, you can request to be paid through [our OpenCollective](https://opencollective.com/mastodon).
  14
  15 ## Bug reports
  16
  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.
  18
  19 ## Translations
  20
  21 You can submit translations via [Crowdin](https://crowdin.com/project/mastodon). They are periodically merged into the codebase.
  22
  23 [![Crowdin](https://d322cqt584bo4o.cloudfront.net/mastodon/localized.svg)](https://crowdin.com/project/mastodon)
  24
  25 ## Pull requests
  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.
  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.
  30
  31 **Pull requests that do not pass automated checks may not be reviewed**. In particular, you need to keep in mind:
  32
  33 - Unit and integration tests (rspec, jest)
  34 - Code style rules (rubocop, eslint)
  35 - 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).