element-android/CONTRIBUTING.md

107 lines
4.2 KiB
Markdown
Raw Normal View History

2019-03-13 19:00:30 +03:00
# Contributing code to Matrix
Please read https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.rst
2019-03-18 20:49:05 +03:00
Android support can be found in this [![Riot Android Matrix room #riot-android:matrix.org](https://img.shields.io/matrix/riot-android:matrix.org.svg?label=%23riot-android:matrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#riot-android:matrix.org) room.
2019-03-13 19:00:30 +03:00
2019-03-18 20:49:05 +03:00
Dedicated room for RiotX: [![RiotX Android Matrix room #riot-android:matrix.org](https://img.shields.io/matrix/riotx:matrix.org.svg?label=%23RiotX:matrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#riotx:matrix.org)
2019-03-13 19:00:30 +03:00
# Specific rules for Matrix Android projects
## Android Studio settings
Please set the "hard wrap" setting of Android Studio to 160 chars, this is the setting we use internally to format the source code (Menu `Settings/Editor/Code Style` then `Hard wrap at`).
## Compilation
For now, the Matrix SDK and the RiotX application are in the same project. So there is no specific thing to do, this project should compile without any special action.
## I want to help translating RiotX
If you want to fix an issue with an English string, please submit a PR.
If you want to fix an issue in other languages, or add a missing translation, or even add a new language, please use [Weblate](https://translate.riot.im/projects/riot-android/).
For the moment, Strings from Riot will be used, there is no dedicated project in Weblate for RiotX.
## I want to submit a PR to fix an issue
Please check if a corresponding issue exists. If yes, please let us know in a comment that you're working on it.
If an issue does not exist yet, it may be relevant to open a new issue and let us know that you're implementing it.
### Kotlin
This project is full Kotlin. Please do not write Java classes.
### CHANGES.md
Please add a line to the top of the file `CHANGES.md` describing your change.
### Code quality
Make sure the following commands execute without any error:
2019-10-11 18:12:51 +03:00
#### Internal tool
2019-10-11 18:18:54 +03:00
<pre>
./tools/check/check_code_quality.sh
</pre>
2019-03-13 19:00:30 +03:00
2019-10-11 18:12:51 +03:00
#### ktlint
2019-10-11 18:18:54 +03:00
<pre>
curl -sSLO https://github.com/pinterest/ktlint/releases/download/0.34.2/ktlint && chmod a+x ktlint
./ktlint --android --experimental -v
</pre>
2019-10-09 16:06:02 +03:00
Note that you can run
2019-10-11 18:18:54 +03:00
<pre>
./ktlint --android --experimental -v -F
</pre>
2019-10-11 18:12:51 +03:00
For ktlint to fix some detected errors for you (you still have to check and commit the fix of course)
2019-10-09 16:06:02 +03:00
2019-10-11 18:12:51 +03:00
#### lint
2019-10-09 16:06:02 +03:00
2019-10-11 18:18:54 +03:00
<pre>
./gradlew lintGplayRelease
./gradlew lintFdroidRelease
</pre>
2019-03-13 19:00:30 +03:00
### Unit tests
Make sure the following commands execute without any error:
2019-10-11 18:18:54 +03:00
<pre>
./gradlew testGplayReleaseUnitTest
</pre>
2019-03-13 19:00:30 +03:00
### Tests
2019-10-11 18:12:51 +03:00
RiotX is currently supported on Android KitKat (API 19+): please test your change on an Android device (or Android emulator) running with API 19. Many issues can happen (including crashes) on older devices.
2019-03-13 19:00:30 +03:00
Also, if possible, please test your change on a real device. Testing on Android emulator may not be sufficient.
### Internationalisation
When adding new string resources, please only add new entries in file `value/strings.xml`. Translations will be added later by the community of translators with a specific tool named [Weblate](https://translate.riot.im/projects/riot-android/).
Do not hesitate to use plurals when appropriate.
2019-10-31 13:11:03 +03:00
### Accessibility
Please consider accessibility as an important point. As a minimum requirement, in layout XML files please use attributes such as `android:contentDescription` and `android:importantForAccessibility`, and test with a screen reader if it's working well. You can add new string resources, dedicated to accessibility, in this case, please prefix theirs id with `a11y_`.
2019-03-13 19:00:30 +03:00
### Layout
When adding or editing layouts, make sure the layout will render correctly if device uses a RTL (Right To Left) language.
You can check this in the layout editor preview by selecting any RTL language (ex: Arabic).
Also please check that the colors are ok for all the current themes of RiotX. Please use `?attr` instead of `@color` to reference colors in the layout. You can check this in the layout editor preview by selecting all the main themes (`AppTheme.Status`, `AppTheme.Dark`, etc.).
### Authors
Feel free to add an entry in file AUTHORS.md
## Thanks
Thanks for contributing to Matrix projects!