Skip to content

Commit 0aac133

Browse files
committed
Add docs for bug reporting
1 parent 378f6f4 commit 0aac133

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

docs/users/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@ This is a work-in-progress effort to document things relevant to Password Store
88
- [Importing from other password managers] : How to migrate to `pass`
99
- [Invalid GPG key ID] : Why this error happens and how you can fix it
1010
- [Release channels] : Different ways to get prebuilt binaries of APS
11+
- [Reporting bugs] : Helpful information on how to craft good bug reports
1112

1213
[Autofill]: autofill
1314
[build types]: build-types
1415
[release channels]: release-channels
1516
[invalid gpg key id]: invalid-gpg-key-id
1617
[importing from other password managers]: importing
1718
[background killing bugs]: background-killing-bugs
19+
[reporting bugs]: reporting-bugs

docs/users/reporting-bugs.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Reporting bugs
2+
3+
When submitting a bug report, it is often helpful to include a log. The following steps can be followed on any Linux machine to capture the logs for Password Store in a text file that you can attach to a GitHub issue.
4+
5+
- Download the Android Platform Tools from [here](https://developer.android.com/studio/releases/platform-tools) and extract them into a directory
6+
- Enable developer options on your device and turn on USB debugging by following [these steps](https://developer.android.com/studio/debug/dev-options)
7+
- Enable debug logging for Password Store by going to Settings > Misc
8+
- Open a new terminal in the directory where you extracted the platform tools
9+
- Run `./adb shell am force-stop app.passwordstore` to close the app
10+
- Launch the app again and replicate the issue
11+
- Run `./adb logcat --pid=$(./adb shell pidof -s app.passwordstore) -d > log.txt` to capture the logs up till that point
12+
- Upload `log.txt` either to the GitHub issue or email it to `googleplay@passwordstore.app` with the issue link

0 commit comments

Comments
 (0)