mirror of
https://github.com/syncthing/syncthing-android.git
synced 2024-11-30 00:01:19 +00:00
65 lines
2.3 KiB
Markdown
65 lines
2.3 KiB
Markdown
## Reporting An Issue
|
|
|
|
Please search for existing issues before opening a new one.
|
|
|
|
### Where To Report
|
|
|
|
Issues might be related either to Syncthing, syncthing-android or both. The general rule of thumb is this:
|
|
If the issue has to do with synchronization, discovery, the web interface, or can be reproduced on a desktop, it should be posted at [syncthing](https://github.com/calmh/syncthing/issues).
|
|
|
|
If the issue is related to the Android UI, background service, or can't be reproduced on a desktop running the same Syncthing version, it should be posted here.
|
|
|
|
For general usage help or questions, you should post to [discourse](http://discourse.syncthing.net/category/support).
|
|
|
|
### Bug Reports
|
|
|
|
A bug report should include the following information:
|
|
|
|
Description of the problem.
|
|
|
|
Steps to reproduce:
|
|
|
|
1. This is the first step
|
|
2. This is the second step
|
|
3. Further steps, etc.
|
|
|
|
Observed behaviour and expected behaviour.
|
|
|
|
syncthing-android version: x.x.x
|
|
|
|
Device name and Android version:
|
|
|
|
versions of involved Syncthing nodes: vx.x.x, ...
|
|
|
|
logcat: *link to file*: Use the log window (Settings -> Open Log -> Android Log -> Share)
|
|
|
|
config.xml: *link to file* (if it might be related, located in `/data/data/com.nutomic.syncthingandroid`, use the export functionality and fetch the file at /sdcard/backups/syncthing/config.xml)
|
|
|
|
screenshots: *link to file* (only for UI problems)
|
|
|
|
|
|
## Running Syncthing directly
|
|
|
|
If you can't start the app, you may be asked to execute the Syncthing binary from a command line.
|
|
|
|
This requires root permissions!
|
|
|
|
First, open a shell on you device, either through adb or with an app. Then, execute the following commands:
|
|
```
|
|
cd data/data/com.nutomic.syncthingandroid/lib/
|
|
./libsyncthing.so -home data/data/com.nutomic.syncthingandroid/files/
|
|
```
|
|
|
|
You can also pass [environment variables](http://docs.syncthing.net/dev/debugging.html#debugging) to Syncthing.
|
|
|
|
|
|
|
|
## Pull Requests
|
|
|
|
Always welcome.
|
|
|
|
Code should follow the [Android Code Style Guidelines](https://source.android.com/source/code-style.html#java-language-rules). This can be done automatically in Android Studio.
|
|
|
|
Unit tests are available, and can be executed with `gradle connectedAndroidTest`, or from Android Studio. New code should always come with tests.
|
|
|
|
Lint warnings should be fixed. If that's not possible, they should be ignored as specifically as possible.
|