1
0
Fork 0
mirror of https://github.com/syncthing/syncthing-android.git synced 2024-12-23 03:11:30 +00:00
syncthing-android/CONTRIBUTING.md
2023-11-08 18:54:44 +01:00

48 lines
1.7 KiB
Markdown

## Reporting Bugs
Please file bugs in the [Github Issue
Tracker](https://github.com/syncthing/syncthing-android/issues). Bugs that
are not specific to Syncthing-Android should be reported to the
[main project](https://github.com/syncthing/syncthing/issues) instead.
Include at least the following in your issue report:
- What happened
- What did you expect to happen instead of what *did* happen, if it's
not crazy obvious
- What version of Android, Syncthing and Syncthing-Android you are
running
- Screenshot if the issue concerns something visible in the GUI
- Console log entries, where possible and relevant
You can get logs in various ways:
- Log window in the app: Settings -> Open Log -> Android Log
- Install [adb](http://www.howtogeek.com/125769/how-to-install-and-use-abd-the-android-debug-bridge-utility/),
and run `adb logcat`. To see only info about crashes, run `adb logcat -s *:E`.
- Using one of the various "logcat apps" on Google Play and F-Droid
## Contributing Translations
All translations are done via
[Hosted Weblate](https://hosted.weblate.org/projects/syncthing/android/). If you
wish to contribute to a translation, just head over there and sign up.
Before every release, the language resources are updated from the
latest info on Weblate.
## Contributing Code
Every contribution is welcome. If you want to contribute but are unsure
where to start, any open issues are fair game!
Code should follow the
[Android Code Style Guidelines](https://source.android.com/source/code-style.html#java-language-rules),
which are used by default in Android Studio.
Unit tests are available, and can be executed from Android Studio, or from
the terminal with `gradle connectedAndroidTest`.