Skip to content

Commit 12a4856

Browse files
committed
Merge branch 'feature/contribution-experience'
2 parents 0b9392a + fb98fa5 commit 12a4856

18 files changed

Lines changed: 324 additions & 365 deletions

.github/ISSUE_TEMPLATE/config.yml

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

.github/ISSUE_TEMPLATE/new_package_entry.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 🆕 New Package Entry
1+
name: New Package Entry
22
description: Submit a new bloatware package to add to the registry
33
title: "[NEW PACKAGE]: "
44
labels: ["enhancement", "new-package"]
@@ -82,10 +82,10 @@ body:
8282
label: Risk Level
8383
description: How safe is it to remove this package?
8484
options:
85-
- 🟢 Safe - No system functionality affected
86-
- 🟡 Caution - May affect some functionality
87-
- 🔴 Dangerous - May cause system instability
88-
- Unknown - Needs more testing
85+
- Safe - No system functionality affected
86+
- Caution - May affect some functionality
87+
- Dangerous - May cause system instability
88+
- Unknown - Needs more testing
8989
validations:
9090
required: true
9191

@@ -114,11 +114,11 @@ body:
114114
**Testing Method:** Removed via ADB (pm uninstall --user 0)
115115
116116
**Tests Performed:**
117-
- Basic phone functions: Working
117+
- Basic phone functions: Working
118118
- Affected features: Bixby not launching (expected)
119-
- System stability: No issues
120-
- Boot time: Normal
121-
- Other apps: No crashes
119+
- System stability: No issues
120+
- Boot time: Normal
121+
- Other apps: No crashes
122122
123123
**Recovery Tested:** Yes, successfully reinstalled with cmd package install-existing
124124
validations:

.github/ISSUE_TEMPLATE/removal_problem_report.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 🐛 Removal Problem Report
1+
name: Removal Problem Report
22
description: Report issues encountered when removing a specific package
33
title: "[REMOVAL ISSUE]: "
44
labels: ["bug", "removal-issue"]
@@ -68,10 +68,10 @@ body:
6868
label: Issue Severity
6969
description: How severe is the problem?
7070
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
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
7575
validations:
7676
required: true
7777

.github/ISSUE_TEMPLATE/update_risk_level.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 🔄 Update Risk Level
1+
name: Update Risk Level
22
description: Report incorrect risk level or suggest an update based on new testing
33
title: "[RISK UPDATE]: "
44
labels: ["risk-update", "needs-review"]
@@ -50,10 +50,10 @@ body:
5050
label: Current Risk Level
5151
description: What is the current risk level in the registry?
5252
options:
53-
- 🟢 Safe
54-
- 🟡 Caution
55-
- 🔴 Dangerous
56-
- Unknown
53+
- Safe
54+
- Caution
55+
- Dangerous
56+
- Unknown
5757
validations:
5858
required: true
5959

@@ -63,10 +63,10 @@ body:
6363
label: Proposed Risk Level
6464
description: What should the risk level be changed to?
6565
options:
66-
- 🟢 Safe
67-
- 🟡 Caution
68-
- 🔴 Dangerous
69-
- Unknown
66+
- Safe
67+
- Caution
68+
- Dangerous
69+
- Unknown
7070
validations:
7171
required: true
7272

.github/pull_request_template.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@
88

99
<!-- Check all that apply -->
1010

11-
- [ ] 🆕 New package(s) added
12-
- [ ] 🔄 Updated existing package(s)
13-
- [ ] 🗑️ Removed deprecated package(s)
14-
- [ ] 🔧 Bug fix (non-breaking change which fixes an issue)
15-
- [ ] New feature (non-breaking change which adds functionality)
16-
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
17-
- [ ] 📚 Documentation update
18-
- [ ] 🎨 Code style/formatting changes
11+
- [ ] New package(s) added
12+
- [ ] Updated existing package(s)
13+
- [ ] Removed deprecated package(s)
14+
- [ ] Bug fix (non-breaking change which fixes an issue)
15+
- [ ] New feature (non-breaking change which adds functionality)
16+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
17+
- [ ] Documentation update
18+
- [ ] Code style/formatting changes
1919

2020
## Changes Made
2121

@@ -52,14 +52,14 @@
5252

5353
<!-- Check all that apply -->
5454

55-
- [ ] Tested on actual device
56-
- [ ] Used test mode to verify
57-
- [ ] Package removal successful
58-
- [ ] No system instability observed
59-
- [ ] Affected features documented
60-
- [ ] Recovery/restoration tested
61-
- [ ] ⚠️ Found issues (documented below)
62-
- [ ] Not tested yet (explain why)
55+
- [ ] Tested on actual device
56+
- [ ] Used test mode to verify
57+
- [ ] Package removal successful
58+
- [ ] No system instability observed
59+
- [ ] Affected features documented
60+
- [ ] Recovery/restoration tested
61+
- [ ] Found issues (documented below)
62+
- [ ] Not tested yet (explain why)
6363

6464
### Issues Encountered
6565

.github/workflows/gh-pages.yml

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,61 @@ jobs:
2828
python-version: "3.11"
2929

3030
- name: Generate dataset
31-
run: python scripts/generate_data_bundle.py --out build/data.json --public web/public/data.json
31+
run: |
32+
mkdir -p build web/public
33+
python scripts/generate_data_bundle.py --out build/data.json --public web/public/data.json || true
34+
35+
- name: Check if web directory exists
36+
id: check_web
37+
run: |
38+
if [ -d "web" ] && [ -f "web/package.json" ]; then
39+
echo "exists=true" >> $GITHUB_OUTPUT
40+
else
41+
echo "exists=false" >> $GITHUB_OUTPUT
42+
fi
3243
3344
- name: Set up Node.js
45+
if: steps.check_web.outputs.exists == 'true'
3446
uses: actions/setup-node@v4
3547
with:
3648
node-version: "20"
3749
cache: "npm"
3850
cache-dependency-path: web/package-lock.json
3951

4052
- name: Install dependencies
53+
if: steps.check_web.outputs.exists == 'true'
4154
working-directory: web
4255
run: npm install
4356

4457
- name: Build site
58+
if: steps.check_web.outputs.exists == 'true'
4559
working-directory: web
4660
run: npm run build
4761

62+
- name: Create placeholder page
63+
if: steps.check_web.outputs.exists == 'false'
64+
run: |
65+
mkdir -p web/dist
66+
cat > web/dist/index.html << 'EOF'
67+
<!DOCTYPE html>
68+
<html>
69+
<head>
70+
<title>UIBloatwareRegistry Explorer - Coming Soon</title>
71+
<style>
72+
body { font-family: system-ui; max-width: 800px; margin: 50px auto; padding: 20px; }
73+
h1 { color: #333; }
74+
p { line-height: 1.6; color: #666; }
75+
a { color: #0066cc; }
76+
</style>
77+
</head>
78+
<body>
79+
<h1>UIBloatwareRegistry Explorer</h1>
80+
<p>The web interface is currently under development.</p>
81+
<p>Visit the <a href="https://github.com/PixelCode01/UIBloatwareRegistry">GitHub repository</a> for the command-line tool.</p>
82+
</body>
83+
</html>
84+
EOF
85+
4886
- name: Upload artifact
4987
uses: actions/upload-pages-artifact@v3
5088
with:
@@ -53,6 +91,9 @@ jobs:
5391
deploy:
5492
needs: build
5593
runs-on: ubuntu-latest
94+
permissions:
95+
pages: write
96+
id-token: write
5697
environment:
5798
name: github-pages
5899
url: ${{ steps.deployment.outputs.page_url }}

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,14 @@ adb shell pm path <package.name>
5858

5959
### Safety Checklist
6060

61-
**DO identify packages that are:**
61+
**DO identify packages that are:**
6262
- Manufacturer-specific apps you don't use
6363
- Carrier-installed apps
6464
- Duplicate apps (when alternatives are available)
6565
- Promotional or shopping apps
6666
- OEM assistants you don't use
6767

68-
**DO NOT identify packages that are:**
68+
**DO NOT identify packages that are:**
6969
- Core system services
7070
- Android framework components
7171
- Google Play Services (unless you know what you're doing)
@@ -109,7 +109,7 @@ adb shell pm path <package.name>
109109

110110
Choose the appropriate risk level for each package:
111111

112-
### 🟢 Safe
112+
### Safe
113113
**Definition**: Can be removed without affecting system functionality
114114

115115
**Criteria**:
@@ -123,7 +123,7 @@ Choose the appropriate risk level for each package:
123123
- `com.amazon.mShop.android.shopping` - Amazon Shopping
124124
- `com.netflix.mediaclient` - Netflix (pre-installed)
125125

126-
### 🟡 Caution
126+
### Caution
127127
**Definition**: May affect some functionality, but system remains stable
128128

129129
**Criteria**:
@@ -136,7 +136,7 @@ Choose the appropriate risk level for each package:
136136
- `com.samsung.android.messaging` - Samsung Messages
137137
- `com.google.android.apps.maps` - Google Maps
138138

139-
### 🔴 Dangerous
139+
### Dangerous
140140
**Definition**: May cause system instability, boot loops, or critical feature loss
141141

142142
**Criteria**:
@@ -151,7 +151,7 @@ Choose the appropriate risk level for each package:
151151
- `com.google.android.gms` - Google Play Services
152152
- `com.android.systemui` - System UI
153153

154-
### Unknown
154+
### Unknown
155155
**Definition**: Not yet tested or categorized
156156

157157
**Usage**: Temporary classification until proper testing is done

CONTRIBUTION_GUIDE.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ The new contribution system simplifies adding bloatware packages to the registry
66

77
## What's New?
88

9-
### Before (Old System)
9+
### Before (Old System)
1010
To add a new package, you needed to:
1111
1. Edit the brand's Python file (`Samsung/samsung_remover.py`)
1212
2. Edit the brand's Shell script (`Samsung/samsung_remover.sh`)
1313
3. Edit the brand's Markdown file (`Samsung/samsung-bloatware-list.md`)
1414
4. Ensure consistency across all three files
1515
5. Know Python, Shell, and Markdown syntax
1616

17-
### 🎉 After (New System)
17+
### After (New System)
1818
Now you can:
1919
1. Run `python contribute.py` (interactive tool)
2020
2. OR edit `packages_registry.json` directly
@@ -85,46 +85,46 @@ Edit `packages_registry.json` directly:
8585
### New System
8686
```
8787
UIBloatwareRegistry/
88-
├── packages_registry.json # Single source of truth
89-
├── contribute.py # Contribution tool
88+
├── packages_registry.json # Single source of truth
89+
├── contribute.py # Contribution tool
9090
├── core/
91-
│ └── package_registry.py # Registry manager
91+
│ └── package_registry.py # Registry manager
9292
├── .github/
93-
│ ├── ISSUE_TEMPLATE/ # Issue templates
93+
│ ├── ISSUE_TEMPLATE/ # Issue templates
9494
│ │ ├── new_package_entry.yml
9595
│ │ ├── update_risk_level.yml
9696
│ │ └── removal_problem_report.yml
97-
│ └── pull_request_template.md # PR template
98-
└── CONTRIBUTING.md # Enhanced guidelines
97+
│ └── pull_request_template.md # PR template
98+
└── CONTRIBUTING.md # Enhanced guidelines
9999
```
100100

101101
### Old System (Deprecated)
102102
```
103103
UIBloatwareRegistry/
104104
├── Samsung/
105-
│ ├── samsung_remover.py # ⚠️ Will use registry
106-
│ ├── samsung_remover.sh # ⚠️ May be deprecated
107-
│ └── samsung-bloatware-list.md # ⚠️ Generated from registry
105+
│ ├── samsung_remover.py # Will use registry
106+
│ ├── samsung_remover.sh # May be deprecated
107+
│ └── samsung-bloatware-list.md # Generated from registry
108108
```
109109

110110
## Risk Level Guidelines
111111

112-
### 🟢 SAFE
112+
### SAFE
113113
- No system functionality affected
114114
- Can be removed without concerns
115115
- Examples: Bixby, Samsung Cloud, carrier apps
116116

117-
### 🟡 CAUTION
117+
### CAUTION
118118
- May affect some functionality
119119
- Remove only if you don't use it
120120
- Examples: Default SMS app, Browser
121121

122-
### 🔴 DANGEROUS
122+
### DANGEROUS
123123
- May cause system instability
124124
- NOT recommended for average users
125125
- Examples: Google Play Services, System launcher
126126

127-
### UNKNOWN
127+
### UNKNOWN
128128
- Not yet tested or categorized
129129
- Research before removing
130130
- Treat as DANGEROUS until proven otherwise
@@ -169,14 +169,14 @@ python contribute.py
169169
```
170170

171171
Features:
172-
- Add new packages
173-
- Update existing packages
174-
- Remove packages
175-
- Search packages
176-
- View brands and categories
177-
- Risk level guidelines
178-
- Input validation
179-
- Duplicate detection
172+
- Add new packages
173+
- Update existing packages
174+
- Remove packages
175+
- Search packages
176+
- View brands and categories
177+
- Risk level guidelines
178+
- Input validation
179+
- Duplicate detection
180180

181181
### CLI Mode
182182
```bash
@@ -303,10 +303,10 @@ A: Git version control keeps everything safe. Just submit a correction PR!
303303

304304
## Support
305305

306-
- 📖 Read [CONTRIBUTING.md](../CONTRIBUTING.md)
307-
- 💬 Start a [Discussion](https://github.com/PixelCode01/UIBloatwareRegistry/discussions)
308-
- 🐛 Report an [Issue](https://github.com/PixelCode01/UIBloatwareRegistry/issues)
306+
- Read [CONTRIBUTING.md](../CONTRIBUTING.md)
307+
- Start a [Discussion](https://github.com/PixelCode01/UIBloatwareRegistry/discussions)
308+
- Report an [Issue](https://github.com/PixelCode01/UIBloatwareRegistry/issues)
309309

310310
---
311311

312-
**Happy Contributing! 🎉**
312+
**Happy Contributing!**

0 commit comments

Comments
 (0)