2016-08-02 16:50:17 +00:00
|
|
|
## Reporting Bugs
|
2014-05-31 16:05:25 +00:00
|
|
|
|
2016-08-02 16:50:17 +00:00
|
|
|
Please file bugs in the [Github Issue
|
2018-08-19 21:42:56 +00:00
|
|
|
Tracker](https://github.com/Catfriend1/syncthing-android/issues). Bugs that
|
2016-08-02 16:50:17 +00:00
|
|
|
are not specific to Syncthing-Android should be reported to the
|
2018-08-19 21:42:56 +00:00
|
|
|
[upstream project](https://github.com/syncthing/syncthing/issues) instead.
|
2016-08-02 16:50:17 +00:00
|
|
|
Include at least the following in your issue report:
|
2014-05-31 16:05:25 +00:00
|
|
|
|
2016-08-02 16:50:17 +00:00
|
|
|
- What happened
|
2014-05-31 16:05:25 +00:00
|
|
|
|
2016-08-02 16:50:17 +00:00
|
|
|
- What did you expect to happen instead of what *did* happen, if it's
|
|
|
|
|
not crazy obvious
|
2014-05-31 16:05:25 +00:00
|
|
|
|
2016-08-02 16:50:17 +00:00
|
|
|
- What version of Android, Syncthing and Syncthing-Android you are
|
|
|
|
|
running
|
2014-05-31 16:05:25 +00:00
|
|
|
|
2016-08-02 16:50:17 +00:00
|
|
|
- Screenshot if the issue concerns something visible in the GUI
|
2014-05-31 16:05:25 +00:00
|
|
|
|
2016-08-02 16:50:17 +00:00
|
|
|
- Console log entries, where possible and relevant
|
2014-05-31 16:05:25 +00:00
|
|
|
|
2016-08-02 16:50:17 +00:00
|
|
|
You can get logs in various ways:
|
2014-05-31 16:05:25 +00:00
|
|
|
|
2016-08-02 16:50:17 +00:00
|
|
|
- Log window in the app: Settings -> Open Log -> Android Log
|
2014-05-31 16:05:25 +00:00
|
|
|
|
2016-12-05 05:06:39 +00:00
|
|
|
- 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`.
|
2014-05-31 16:05:25 +00:00
|
|
|
|
2016-08-02 16:50:17 +00:00
|
|
|
- Using one of the various "logcat apps" on Google Play and F-Droid
|
2014-05-31 16:05:25 +00:00
|
|
|
|
2016-08-02 16:50:17 +00:00
|
|
|
## Contributing Code
|
2014-05-31 16:05:25 +00:00
|
|
|
|
2016-08-02 16:50:17 +00:00
|
|
|
Every contribution is welcome. If you want to contribute but are unsure
|
|
|
|
|
where to start, any open issues are fair game!
|
2014-05-31 16:05:25 +00:00
|
|
|
|
2016-08-02 16:50:17 +00:00
|
|
|
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.
|
2015-05-05 22:39:12 +00:00
|
|
|
|
2016-08-02 16:50:17 +00:00
|
|
|
Unit tests are available, and can be executed from Android Studio, or from
|
|
|
|
|
the terminal with `gradle connectedAndroidTest`.
|
