Contributions are welcome, whether you have discovered a bug or have an idea to improve the app.
- Create issue
- Fork project
- Create fix/feature/etc branch
- Make and test changes
- Create pullrequest and attach issue
Always create an issue when contributing, whether you contribute fixes, improvements, etc. This way others can follow along. Also make sure to use the of the available labels.
For new features and and major changes create an issue with a feature label. New features have to be approved first.
When creating a pullrequest, make sure to fill out the pullrequest template and to
Checklist before pullrequest:
- Tests created
- Changes tested on latest device API
- Self review of code
- Pipeline ok
[breaking] type(affected_code_keyword): Descriptive title
(Optional) [breaking]:
Breaking "label" for breaking changes to app. Must be within brackets.
(Optional) affected_code_keyword:
Keyword(s) for affected part of code. Can be comma separated when multiple parts of code are affected. Parenthesis are optional when no keyword is necessary.
type:
| type | description |
|---|---|
| feat | feature for app |
| fix | fix for app |
| test | fix or add test |
| chore or base | housekeeping tasks, package updates, etc. |
| docs | changes to documentation |
| pipe or bot | changes to CI/CD pipeline or bot |
Examples:
feat(graph): Improve graph data layout
[breaking] feat(database): Remove field
fix(backup): Add new permissions to Android
docs: Update contribution guide