forked from upstream-mirrors/OpenTracks
Update CONTRIBUTING.md
This commit is contained in:
+5
-5
@@ -12,17 +12,17 @@ You have a cool idea for a feature that is missing in OpenTracks?
|
|||||||
And you would like to help by implementing it?
|
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).
|
If not, you can just take a look at the [issue tracker](https://github.com/OpenTracksApp/OpenTracks/issues).
|
||||||
|
|
||||||
Helpful hints:
|
Advices:
|
||||||
* creating an issue beforehand might be helpful
|
* creating an issue beforehand might be a good idea
|
||||||
Sometimes it is helpful to discuss your idea and also your implementation approach first.
|
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.
|
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.
|
It also makes merging your changes easier and, usually, faster.
|
||||||
* please only add new dependencies if is absolutely necessary.
|
* please only add new dependencies if is absolutely necessary
|
||||||
If you need to:
|
If you need to:
|
||||||
* tell us why those are required,
|
* tell us why those are required,
|
||||||
* what alternatives are existing, and
|
* what alternatives are existing, and
|
||||||
* why you choose this dependency.
|
* why you choose this dependency.
|
||||||
And also verify that the license(s) are compatible with _Apache 2.0_.
|
And also verify that the license(s) are compatible with _Apache 2.0_ as well as open-source.
|
||||||
|
|
||||||
## Coding conventions
|
## Coding conventions
|
||||||
|
|
||||||
@@ -32,4 +32,4 @@ And follow the _scout rule_.
|
|||||||
|
|
||||||
You can take a look at existing code and get a feeling for it.
|
You can take a look at existing code and get a feeling for it.
|
||||||
|
|
||||||
Please autoformat your using AndroidStudio's code formatter.
|
Please autoformat your code using AndroidStudio's code formatter.
|
||||||
|
|||||||
Reference in New Issue
Block a user