syncthing-android/CONTRIBUTING.md

Reporting Bugs

Please file bugs in the GitHub Issue Tracker. Bugs that are not specific to Syncthing-Android should be reported to the main project 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, 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. 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, 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.