Simple email application for Android. Original source code: https://framagit.org/dystopia-project/simple-email
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

29 lines
1.6 KiB

  1. # Contribution guide
  2. We're thrilled you're interested in contributing to SimpleEmail! There are lots of ways to get involved - see below for details.
  3. ## Documentation
  4. Contributions to this document and the frequently asked questions
  5. are preferred in the form of [pull requests][pull-requests]).
  6. ## Translations
  7. * You can translate the in-app texts of SimpleEmail please open a [pull requests][pull-requests] (looking for a web service).
  8. * If your language is not listed, please open a [issue][] or send a message through [email](distopico@riseup.net)
  9. ## Source code
  10. Source code contributions are welcome, there's always work to be done on the SimpleEmail codebase, building from source code is
  11. straightforward with [Android Studio](http://developer.android.com/sdk/). Here are the general rules:
  12. * Write good commit messages, we follow the [conventional commits][commits]
  13. * Make sure the linter (`./gradlew lint`) passes (in progress)
  14. * Stick to [F-Droid contribution guidelines](https://f-droid.org/wiki/page/Inclusion_Policy)
  15. * Make changes on a separate branch, not on the master branch. This is commonly known as *feature branch workflow*
  16. * Send patches via [Pull Requests][pull-requests], you branch should follow this convention: `[type]-[description]` example `feat-improve-performance`
  17. * When submitting changes, you confirm that your code is licensed under the terms of the [GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.html).
  18. * Please test (compile and run) your code before you submit changes
  19. [commits]: https://www.conventionalcommits.org/en/v1.0.0-beta.2/
  20. [pull-requests]: https://framagit.org/dystopia-project/simple-email/merge_requests