From faad451e22b31055525d661cd9544ca5260bac67 Mon Sep 17 00:00:00 2001 From: Dennis Guse Date: Wed, 2 Sep 2020 08:10:55 +0200 Subject: [PATCH] Added contribution guidelines --- CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..0d9eee272 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# How to contribute? + +## Testing + +Just use OpenTracks and tell us what can be improved by opening an issue [here](https://github.com/OpenTracksApp/OpenTracks/issues/new/choose) + +If we broke things (happens now and then), please tell us also. + +## Coding new features + +You have a cool idea for a feature that is missing in OpenTracks? +And you would like to help by implementing it? +If not, you can just take a look at the [issue tracker](https://github.com/OpenTracksApp/OpenTracks/issues). + +Helpful hints: +* creating an issue beforehand might be helpful + Sometimes it is helpful to discuss your idea and also your implementation approach first. + We may be able to give you some hints on how to tackle the problem. + It also makes merging your changes easier and, usually, faster. +* please only add new dependencies if is absolutely necessary. + If you need to: + * tell us why those are required, + * what alternatives are existing, and + * why you choose this dependency. + And also verify that the license(s) are compatible with _Apache 2.0_. + +## Coding conventions + +None so far. +Just keep it simple. +And follow the _scout rule_. + +You can take a look at existing code and get a feeling for it. + +Please autoformat your using AndroidStudio's code formatter.