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

Refactor: Explicitly include codestyle for XML files

Browse Source
This commit is contained in:
Brijesh Shah 2018-02-28 23:02:00 +05:30 committed by Isaac Hutt
parent a8d5f5cfc4
commit 90ba3a6bdf
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/codestyle.md
View File

@ -4,7 +4,16 @@ Our code style guidelines is based on the [Google Java Style Guide](https://goog
Do take some time to read it.
Only a few extra rules:
### For XML files
Kiwix follows `2dp` for the `Indent` and `Continuous Indent` values. 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
- Line length is 120 characters
- FIXME must not be committed in the repository use TODO instead. FIXME can be used in your own local repository only.
@ -19,7 +28,7 @@ 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 underscores in variable names