ProtonMail
/
proton-mail-android
mirror of https://github.com/ProtonMail/proton-mail-android
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated Contributions section of README.md 

#comment Better description of `fix` prefix for branch naming.
Fixed 2 typos
Affected: README.md

MAILAND-599
This commit is contained in:
Davide Farella 2020-04-30 16:45:20 +02:00 committed by Zorica Stojchevska
parent 6fa62b2e70
commit 48dcde9fa8
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -43,11 +43,11 @@ Branch names must respect the pattern `type/description-of-the-change`.
* `chore` for changes not related to the Kotlin source code, for example a change in the build config
* `doc` for changes related to source code documentation, or external document, like the README
* `feat` for a new feature for the app
* `fix` for fixing a feature that contains a bug
* `fix` for bug fixes
* `refactor` for improving one or more unit of code, without impacting the behaviour of the app
* `test` for everything related to test ( add a new test suite, add a new test into an already existing test suite or improve/modify the performance or the behaviour of an already existing test )
_description of change_ must be a concise and meaninful description of what is expected by the change apported; words must be separated by a dash `-`
_description of change_ must be a concise and meaningful description of what is expected by the change apported; words must be separated by a dash `-`
The whole name of the branch must be lower case.
@ -72,7 +72,7 @@ _Title_ is required and must start with a capital letter.
The code must conform the standards defined in the files `config/CodeStyle.xml` and `config/detekt.xml`.
`CodeStyle.xml` can be imported in the IDE ( _Prefecerenes -> Editor -> Code Style -> Import scheme_ for IntelliJ and Android Studio ).
`CodeStyle.xml` can be imported in the IDE ( _Preferences -> Editor -> Code Style -> Import scheme_ for IntelliJ and Android Studio ).
Detekt reports can be generated with the command `./gradlew detekt`. Check _Detekt GitHub_ documentation for know how to download and configure the **optional** IDE plugin.