syncthing-android/CONTRIBUTING.md

48 lines
1.5 KiB
Markdown
Raw Normal View History

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
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:
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-08-02 16:50:17 +00:00
- In the terminal over USB: `adb logcat`
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 Translations
2014-05-31 16:05:25 +00:00
2016-08-02 16:50:17 +00:00
All translations are done via
[Transifex](https://www.transifex.com/projects/p/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 Transifex.
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`.