kiwix/kiwix-android
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-android.git synced 2025-08-03 10:46:53 -04:00
Code Issues Packages Projects Releases Wiki Activity

#1307 update readme

Browse Source
This commit is contained in:
Sean Mac Gillicuddy 2019-07-26 10:40:54 +01:00
parent 677cd2cdac
commit 222c303299
1 changed files with 2 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/codestyle.md
View File

@ -2,32 +2,13 @@
Our code style guidelines is based on the [Square's Android Style Guide](https://github.com/square/java-code-styles/blob/master/configs/codestyles/SquareAndroid.xml). Our code style guidelines is based on the [Square's Android Style Guide](https://github.com/square/java-code-styles/blob/master/configs/codestyles/SquareAndroid.xml).
Download the xml file and [import it](https://user-images.githubusercontent.com/1624385/37678878-9b61b562-2c7f-11e8-9733-d1d593f0aa67.png) in IntelliJ/Android Studio. Our code style is managed in version control and will be installed automatically when you clone the repo.
### For XML files
Kiwix follows `2 spaces` for the `Indent` and `4 spaces` for the `Continuous Indent` values. (Same as that in Square's Style Guide) You can update these values using following steps:
- Go to **Settings** -> **Editor** -> **Code Style** -> **XML**
- Update the respective values under the **Tabs and Indents** tab
After changing the values, one can simply select the files to indent, `Right click` -> `Reformat Code` -> Check `Rearrange entries` -> `OK`.
### Only a few extra rules ### Only a few extra rules
- Line length is 120 characters - Line length is 100 characters
- FIXME must not be committed in the repository use TODO instead. FIXME can be used in your own local repository only. - FIXME must not be committed in the repository use TODO instead. FIXME can be used in your own local repository only.
You can run a checkstyle with most rules via a gradle command:
```
$ ./gradlew checkstyle
```
It generates a HTML report in `build/reports/checkstyle/checkstyle.html`.
Try to remove as much warnings as possible, It's not completely possible to remove all the warnings, but over a period of time, we should try to make it as complete as possible.
### Some **DONT's** ### Some **DONT's**
- Don't use Hungarian Notation like `mContext` `mCount` etc - Don't use Hungarian Notation like `mContext` `mCount` etc