Thanks for throwing some effort into helping us improve our project! This is a set of guidelines to contributing to the UserLAnd Android application. These are intended as just that: guidelines, so use your best judgement when submitting contributions.
All contributions must follow the UserLAnd Code of Conduct.
- Submit an issue describing the problem you will be solving with your contribution if one doesn't exist. Assign yourself to the ticket.
- Fork from staging.
- Write your code.
- Test your code.
- Ensure that your code follows our styling by running
./gradlew ktlintat the root of the project. - Submit a pull request to staging!
Commit Messages
- Use present tense.
- Keep the first line short, but feel free to reference issues etc. in lines after.
Branch Names
- Reference issue number in branch name.
- Describe issue solved in branch name as briefly as possible.