Skip to content

Commit 73f9eea

Browse files
PixelCode01PixelCode01
authored
Merge pull request #11 from PixelCode01/feature/contribution-experience
adds issue template and pr template
2 parents ca614c2 + e4462ec commit 73f9eea

File tree

7 files changed

+1249
-42
lines changed

7 files changed

+1249
-42
lines changed

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 💬 General Discussion
4+
url: https://github.com/PixelCode01/UIBloatwareRegistry/discussions
5+
about: Ask questions and discuss with the community
6+
- name: 📚 Documentation
7+
url: https://github.com/PixelCode01/UIBloatwareRegistry/blob/main/README.md
8+
about: Read the documentation and usage guides
9+
- name: 🤝 Contributing Guide
10+
url: https://github.com/PixelCode01/UIBloatwareRegistry/blob/main/CONTRIBUTING.md
11+
about: Learn how to contribute to the project

‎.github/ISSUE_TEMPLATE/new_package_entry.yml‎

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
name: 🆕 New Package Entry
2+
description: Submit a new bloatware package to add to the registry
3+
title: "[NEW PACKAGE]: "
4+
labels: ["enhancement", "new-package"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Thank you for contributing to UIBloatwareRegistry!
10+
11+
Please fill out this form to add a new bloatware package to the registry.
12+
Make sure you've tested the package removal safely before submitting.
13+
14+
- type: dropdown
15+
id: brand
16+
attributes:
17+
label: Device Brand
18+
description: Which brand does this package belong to?
19+
options:
20+
- Samsung
21+
- Xiaomi
22+
- Oppo
23+
- Vivo
24+
- Realme
25+
- OnePlus
26+
- Huawei
27+
- Honor
28+
- Motorola
29+
- Nothing
30+
- Tecno
31+
- Infinix
32+
- Lenovo
33+
- Google
34+
- Asus
35+
- Other (specify in description)
36+
validations:
37+
required: true
38+
39+
- type: input
40+
id: package_name
41+
attributes:
42+
label: Package Name
43+
description: The full package identifier
44+
placeholder: "com.example.bloatware"
45+
validations:
46+
required: true
47+
48+
- type: input
49+
id: description
50+
attributes:
51+
label: Description
52+
description: Brief, user-friendly description of what this app/service does
53+
placeholder: "Bixby Voice Assistant"
54+
validations:
55+
required: true
56+
57+
- type: dropdown
58+
id: category
59+
attributes:
60+
label: Category
61+
description: What category does this package belong to?
62+
options:
63+
- System Apps
64+
- OEM Apps (Samsung, Xiaomi, etc.)
65+
- OEM Services
66+
- Google Apps
67+
- Carrier Apps
68+
- Social Media
69+
- Gaming
70+
- Shopping
71+
- News/Entertainment
72+
- Productivity
73+
- Voice Assistant
74+
- Cloud Services
75+
- Other (specify below)
76+
validations:
77+
required: true
78+
79+
- type: dropdown
80+
id: risk
81+
attributes:
82+
label: Risk Level
83+
description: How safe is it to remove this package?
84+
options:
85+
- 🟢 Safe - No system functionality affected
86+
- 🟡 Caution - May affect some functionality
87+
- 🔴 Dangerous - May cause system instability
88+
- ⚪ Unknown - Needs more testing
89+
validations:
90+
required: true
91+
92+
- type: textarea
93+
id: risk_rationale
94+
attributes:
95+
label: Risk Level Rationale
96+
description: Explain why you chose this risk level
97+
placeholder: |
98+
- System Integration: Low
99+
- Dependencies: None found
100+
- User Impact: Only affects Bixby features
101+
- Recovery: Easy (can reinstall)
102+
- Testing: Removed on 3 devices without issues
103+
validations:
104+
required: true
105+
106+
- type: textarea
107+
id: testing
108+
attributes:
109+
label: Testing Information
110+
description: Provide details about your testing
111+
placeholder: |
112+
**Device Model:** Samsung Galaxy S21
113+
**Android Version:** Android 12 / One UI 4.1
114+
**Testing Method:** Removed via ADB (pm uninstall --user 0)
115+
116+
**Tests Performed:**
117+
- Basic phone functions: ✅ Working
118+
- Affected features: Bixby not launching (expected)
119+
- System stability: ✅ No issues
120+
- Boot time: ✅ Normal
121+
- Other apps: ✅ No crashes
122+
123+
**Recovery Tested:** Yes, successfully reinstalled with cmd package install-existing
124+
validations:
125+
required: true
126+
127+
- type: textarea
128+
id: affected_features
129+
attributes:
130+
label: Affected Features
131+
description: What features or functionality will be affected if this package is removed?
132+
placeholder: |
133+
- Bixby voice commands will not work
134+
- Bixby button will be non-functional
135+
- No impact on other system features
136+
validations:
137+
required: false
138+
139+
- type: input
140+
id: alternatives
141+
attributes:
142+
label: Alternative Apps (Optional)
143+
description: Suggest alternative apps if this package provides essential functionality
144+
placeholder: "Google Assistant, Alexa"
145+
validations:
146+
required: false
147+
148+
- type: checkboxes
149+
id: checklist
150+
attributes:
151+
label: Submission Checklist
152+
description: Please confirm you've completed these steps
153+
options:
154+
- label: I have tested the package removal on an actual device
155+
required: true
156+
- label: I have read the risk level guidelines in CONTRIBUTING.md
157+
required: true
158+
- label: The package information is accurate and complete
159+
required: true
160+
- label: I have documented any issues encountered during testing
161+
required: true
162+
- label: I can restore the package if needed
163+
required: true
164+
165+
- type: textarea
166+
id: additional
167+
attributes:
168+
label: Additional Information
169+
description: Any other information that might be helpful
170+
placeholder: |
171+
- Related packages that should also be removed
172+
- Known issues or warnings
173+
- Links to relevant discussions or documentation
174+
validations:
175+
required: false

‎.github/ISSUE_TEMPLATE/removal_problem_report.yml‎

Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
1+
name: 🐛 Removal Problem Report
2+
description: Report issues encountered when removing a specific package
3+
title: "[REMOVAL ISSUE]: "
4+
labels: ["bug", "removal-issue"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Report Package Removal Issues
10+
11+
Use this template to report problems that occurred after removing a specific bloatware package.
12+
13+
- type: dropdown
14+
id: brand
15+
attributes:
16+
label: Device Brand
17+
description: What brand is your device?
18+
options:
19+
- Samsung
20+
- Xiaomi
21+
- Oppo
22+
- Vivo
23+
- Realme
24+
- OnePlus
25+
- Huawei
26+
- Honor
27+
- Motorola
28+
- Nothing
29+
- Tecno
30+
- Infinix
31+
- Lenovo
32+
- Google
33+
- Asus
34+
- Other
35+
validations:
36+
required: true
37+
38+
- type: input
39+
id: device_model
40+
attributes:
41+
label: Device Model
42+
description: Specific device model
43+
placeholder: "Samsung Galaxy S21 Ultra"
44+
validations:
45+
required: true
46+
47+
- type: input
48+
id: android_version
49+
attributes:
50+
label: Android Version
51+
description: Android version and custom UI (if applicable)
52+
placeholder: "Android 13 / One UI 5.1"
53+
validations:
54+
required: true
55+
56+
- type: input
57+
id: package_name
58+
attributes:
59+
label: Package Name
60+
description: Which package caused the issue?
61+
placeholder: "com.example.package"
62+
validations:
63+
required: true
64+
65+
- type: dropdown
66+
id: severity
67+
attributes:
68+
label: Issue Severity
69+
description: How severe is the problem?
70+
options:
71+
- 🔴 Critical - Device won't boot or major functionality lost
72+
- 🟠 High - Important features broken but device usable
73+
- 🟡 Medium - Minor features affected
74+
- 🟢 Low - Cosmetic or very minor issues
75+
validations:
76+
required: true
77+
78+
- type: textarea
79+
id: issue_description
80+
attributes:
81+
label: Issue Description
82+
description: Describe what went wrong after removing the package
83+
placeholder: |
84+
After removing this package:
85+
- Feature X stopped working
86+
- App Y crashes on launch
87+
- System shows error message: "..."
88+
- Device behavior changed: ...
89+
validations:
90+
required: true
91+
92+
- type: textarea
93+
id: removal_method
94+
attributes:
95+
label: Removal Method
96+
description: How did you remove the package?
97+
placeholder: |
98+
Method used:
99+
- [ ] Using this tool (main.py)
100+
- [ ] ADB command: pm uninstall --user 0
101+
- [ ] ADB command: pm uninstall -k --user 0
102+
- [ ] Other ADB command (specify)
103+
- [ ] Third-party app (specify)
104+
validations:
105+
required: true
106+
107+
- type: textarea
108+
id: reproduction_steps
109+
attributes:
110+
label: Steps to Reproduce
111+
description: How can others reproduce this issue?
112+
placeholder: |
113+
1. Remove package using: adb shell pm uninstall --user 0 com.example.package
114+
2. Reboot device
115+
3. Open Settings app
116+
4. Navigate to Feature X
117+
5. Observe error message
118+
validations:
119+
required: true
120+
121+
- type: textarea
122+
id: expected_behavior
123+
attributes:
124+
label: Expected Behavior
125+
description: What did you expect to happen?
126+
placeholder: "Package should be removed safely without affecting other features..."
127+
validations:
128+
required: true
129+
130+
- type: textarea
131+
id: actual_behavior
132+
attributes:
133+
label: Actual Behavior
134+
description: What actually happened?
135+
placeholder: "System crashes when trying to access feature X..."
136+
validations:
137+
required: true
138+
139+
- type: dropdown
140+
id: recovery_attempted
141+
attributes:
142+
label: Recovery Attempted
143+
description: Did you try to fix the issue?
144+
options:
145+
- "Yes - Successfully recovered"
146+
- "Yes - Partially recovered"
147+
- "Yes - Unable to recover"
148+
- "No - Not yet attempted"
149+
validations:
150+
required: true
151+
152+
- type: textarea
153+
id: recovery_method
154+
attributes:
155+
label: Recovery Method (if attempted)
156+
description: What did you try to fix the issue?
157+
placeholder: |
158+
- Reinstalled package: adb shell cmd package install-existing com.example.package
159+
- Factory reset: Yes/No
160+
- Other method: ...
161+
162+
Result: ...
163+
validations:
164+
required: false
165+
166+
- type: textarea
167+
id: logs
168+
attributes:
169+
label: Error Logs (Optional)
170+
description: Provide any relevant error logs or logcat output
171+
placeholder: |
172+
```
173+
Paste logcat or error messages here
174+
```
175+
render: shell
176+
validations:
177+
required: false
178+
179+
- type: textarea
180+
id: related_packages
181+
attributes:
182+
label: Related Packages
183+
description: Were other packages removed at the same time?
184+
placeholder: |
185+
- com.example.package1
186+
- com.example.package2
187+
validations:
188+
required: false
189+
190+
- type: checkboxes
191+
id: checklist
192+
attributes:
193+
label: Checklist
194+
options:
195+
- label: I have searched for existing issues about this package
196+
required: true
197+
- label: This issue is reproducible (happened multiple times)
198+
required: false
199+
- label: I have tried to recover/restore the package
200+
required: false
201+
- label: I can provide additional testing if needed
202+
required: false
203+
204+
- type: textarea
205+
id: additional
206+
attributes:
207+
label: Additional Context
208+
description: Any other relevant information (screenshots, videos, links)
209+
validations:
210+
required: false

0 commit comments

Comments
 (0)