Skip to content

Commit 802d3e7

Browse files
committed
docs: Update support documentation and templates
1 parent ea68129 commit 802d3e7

File tree

2 files changed

+54
-22
lines changed

2 files changed

+54
-22
lines changed

.github/ISSUE_TEMPLATE/bug_report.yaml

Lines changed: 51 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,55 @@ name: Bug report
22
description: File a bug/issue
33
title: "[Bug] "
44
body:
5-
- type: checkboxes
6-
attributes:
7-
label: Is there an existing issue for this?
8-
options:
9-
- label: I have searched the existing issues
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Before creating a new bug report, please keep the following in mind:
9+
10+
- **Do not submit a duplicate bug report**: Search for existing bug reports [here](https://github.com/chsbuffer/ReVancedXposed/issues?q=%5BBug%5D).
11+
- **Check the troubleshooting guide**: A solution to your issue might be found in the [FAQ](https://github.com/chsbuffer/ReVancedXposed/wiki/Frequently-Asked-Questions).
12+
- type: checkboxes
13+
attributes:
14+
label: Acknowledgements
15+
options:
16+
- label: I have checked all open and closed bug reports and this is not a duplicate.
17+
required: true
18+
- label: I have read the FAQ.
19+
required: true
20+
- type: input
21+
attributes:
22+
label: Environment
23+
description: |
24+
OS version, Android version, Root manager (Magisk/KSU/APatch), LSPosed version.
25+
Example: LineageOS 21, Android 14, Magisk 29.0, JingMatrix/LSPosed-v1.10.2-7182.
26+
validations:
1027
required: true
11-
- type: input
12-
attributes:
13-
label: Environment
14-
description: |
15-
Example: LineageOS 21, Android 14, Magisk 29.0, LSPosed-v1.9.2-7024. Alternatively, upload the LSPosed log.
16-
validations:
17-
required: false
18-
- type: textarea
19-
attributes:
20-
label: Current Behavior
21-
description: |
22-
A concise description of what you're experiencing, along with the version of the application.
23-
24-
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
25-
validations:
26-
required: false
28+
- type: textarea
29+
attributes:
30+
label: Bug description
31+
description: |
32+
- Describe your bug in detail
33+
- Add steps to reproduce the bug if possible (Step 1. ... Step 2. ...)
34+
- Add images and videos if possible
35+
- Include the version of the target application
36+
validations:
37+
required: true
38+
- type: textarea
39+
attributes:
40+
label: Error logs
41+
description: |
42+
- If You are reporting a YouTube bug, enable Debug Logging in YouTube Settings -> ReVanced Settings -> Miscellaneous -> Debugging.
43+
- Reproduce the bug
44+
- Open LSPosed Manager -> Logs
45+
- Save logs
46+
- Upload the saved zip file
47+
validations:
48+
required: true
49+
- type: checkboxes
50+
attributes:
51+
label: Re-acknowledgement
52+
options:
53+
- label: I have chosen an appropriate title.
54+
required: true
55+
- label: I understand that issues without necessary information will be closed without notice.
56+
required: true

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
> - This is **NOT an official ReVanced project**, do not ask the ReVanced developers for help.
1313
> - **Root access** is strictly **required** to use this module!
1414
> - **Spotify is no longer supported!** Get the new module [here](https://github.com/chsbuffer/ReVancedXposed_Spotify)
15+
> - **Having issues?** Check the **[FAQ](https://github.com/chsbuffer/ReVancedXposed/wiki/Frequently-Asked-Questions)** before reporting.
1516
1617
## Downloads
1718
- **Release build**: [Download](https://github.com/chsbuffer/ReVancedXposed/releases/latest)
@@ -74,7 +75,8 @@
7475
- Unlock plus
7576

7677
## Supports
77-
[![Discord Server](https://img.shields.io/badge/Join-Discord-5865F2.svg?logo=discord)](https://discord.gg/QWUrAA2mKq)
78+
[![Discord Server](https://img.shields.io/badge/Join-Discord-5865F2.svg?logo=discord)](https://discord.gg/QWUrAA2mKq)
79+
[![FAQ](https://img.shields.io/badge/Read-FAQ-orange.svg?logo=github)](https://github.com/chsbuffer/ReVancedXposed/wiki/Frequently-Asked-Questions)
7880
or [Create an issue](https://github.com/chsbuffer/ReVancedXposed/issues/new/choose)
7981

8082
## ⭐ Credits

0 commit comments

Comments
 (0)