Contribution guide
We're thrilled you're interested in contributing to SimpleEmail! There are lots of ways to get involved - see below for details.
Documentation
Contributions to this document and the frequently asked questions
are preferred in the form of pull requests.
Translations
- SimpleEmail can be translated via Weblate. You can log in there to help or open a pull requests.
- If your language is not listed, please open a issue or send a message through email
Source code
Source code contributions are welcome, there's always work to be done on the SimpleEmail codebase, building from source code is
straightforward with ./gradlew assembleDebug Here are the general rules:
- Write good commit messages, we follow the conventional commits
- Make sure the linter (
./gradlew lint) passes (in progress)
- Stick to F-Droid contribution guidelines
- Make changes on a separate branch, not on the master branch. This is commonly known as feature branch workflow and
develop as the base
- Send patches via Pull Requests, you branch should follow this convention:
[type]-[description] example feat-improve-performance
- When submitting changes, you confirm that your code is licensed under the terms of the GNU General Public License v3.
- Please test (compile and run) your code before you submit changes