Repository Quality Evaluation & Maksimalisasi
Transform GitHub repos from good (7/10) to perfect (10/10) production-ready state.
When to Use
- User says "gas maksimalkan" or "pastikan perfect"
- Repo needs professional polish for public release
- Want comprehensive CI/CD, tests, and templates
- Preparing repo for community contributions
Quality Scoring Framework
Evaluate across 10 categories (0-10 each):
| Category |
Weight |
What to Check |
| Documentation |
10% |
README completeness, examples, architecture docs |
| Installers/Setup |
10% |
Automated setup, clear instructions, idempotent |
| Templates |
5% |
Starter files, boilerplate, examples |
| CI/CD |
15% |
GitHub Actions, automated testing, status badges |
| Examples |
5% |
Screenshots, demos, video tutorials |
| Badges |
5% |
CI, license, version, stars, forks |
| Changelog |
10% |
CHANGELOG.md, semantic versioning, release notes |
| Releases |
10% |
GitHub releases, tags, versioned artifacts |
| Issue Templates |
15% |
Bug report, feature request, PR templates |
| Tests |
15% |
Test suite, coverage, automated validation |
Scoring:
- 0-3: Missing or broken
- 4-6: Basic/minimal
- 7-8: Good/functional
- 9-10: Excellent/comprehensive
Total Score = Average of all categories
Maksimalisasi Workflow
Phase 1: CHANGELOG + Release (15 min)
Create CHANGELOG.md
cat > CHANGELOG.md << 'EOF'
# Changelog
## [1.1.0] - YYYY-MM-DD
### Added
- Feature A
- Feature B
## [1.0.0] - YYYY-MM-DD
### Added
- Initial release
EOF
Create GitHub release
git tag -a v1.1.0 -m "v1.1.0 - Description"
git push origin v1.1.0
gh release create v1.1.0 --title "v1.1.0 - Title" --notes "Release notes"
Phase 2: Badges + FAQ (20 min)
Add badges to README
[](https://github.com/owner/repo/actions)
[](https://opensource.org/licenses/MIT)
[](https://github.com/owner/repo/releases)
[](https://github.com/owner/repo/stargazers)
[](https://github.com/owner/repo/network/members)
Add FAQ section (before Contributing)
## ❓ FAQ
### **Q: Common question 1?**
**A:** Clear answer with examples.
### **Q: Common question 2?**
**A:** Clear answer with code snippets.
[Add 8-10 questions based on user feedback]
Phase 3: CI/CD + Tests (40 min)
Create GitHub Actions workflow
# .github/workflows/ci.yml
name: CI
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Check Bash syntax
run: |
for script in *.sh; do
bash -n "$script"
done
- name: Validate documentation
run: |
test -f README.md || exit 1
test -f CHANGELOG.md || exit 1
test -f LICENSE || exit 1
- name: Run tests
run: |
if [ -f tests/test.sh ]; then
./tests/test.sh
fi
Create test suite
mkdir -p tests
cat > tests/test.sh << 'EOF'
#!/bin/bash
set -e
echo "=== Running Tests ==="
# Test 1: Syntax validation
echo "Test 1: Syntax validation..."
bash -n script.sh && echo "✅ Syntax OK" || exit 1
# Test 2: File existence
echo "Test 2: Required files..."
test -f README.md && echo "✅ README exists" || exit 1
# Test 3: Documentation completeness
echo "Test 3: Documentation..."
grep -q "Quick Start" README.md && echo "✅ Has Quick Start" || exit 1
echo "✅ ALL TESTS PASSED!"
EOF
chmod +x tests/test.sh
Verify CI passes
git add .github/workflows/ci.yml tests/
git commit -m "feat: add CI/CD and test suite"
git push
# Wait for CI to pass
gh run list --limit 1
Phase 4: Templates (15 min)
Bug report template
mkdir -p .github/ISSUE_TEMPLATE
cat > .github/ISSUE_TEMPLATE/bug_report.md << 'EOF'
---
name: Bug report
about: Create a report to help us improve
title: '[BUG] '
labels: bug
---
## 🐛 Bug Description
Clear description of the bug.
## 📋 To Reproduce
Steps to reproduce:
1. Run command '...'
2. See error '...'
## ✅ Expected Behavior
What you expected to happen.
## 💻 Environment
- OS: [e.g. Ubuntu 24.04]
- Version: [e.g. 1.0.0]
## 🔍 Error Logs
Paste logs here
EOF
Feature request template
cat > .github/ISSUE_TEMPLATE/feature_request.md << 'EOF'
---
name: Feature request
about: Suggest an idea
title: '[FEATURE] '
labels: enhancement
---
## 🚀 Feature Description
Clear description of the feature.
## 💡 Motivation
Why is this needed?
## 📋 Proposed Solution
How should it work?
## ✅ Acceptance Criteria
- [ ] Criterion 1
- [ ] Criterion 2
EOF
PR template
cat > .github/pull_request_template.md << 'EOF'
## 📋 Description
Brief description of changes.
## 🎯 Type of Change
- [ ] 🐛 Bug fix
- [ ] ✨ New feature
- [ ] 💥 Breaking change
- [ ] 📝 Documentation
## ✅ Checklist
- [ ] Code follows style guidelines
- [ ] Self-review completed
- [ ] Documentation updated
- [ ] Tests pass
EOF
Pitfalls
- Don't skip CI verification: Always wait for CI to pass before declaring complete
- Test idempotency: Installers should be safe to run multiple times
- Mock dependencies in tests: CI environment may not have all tools
- Badge order matters: CI badge first (shows quality), then license, version, social proof
- FAQ placement: Before Contributing section, after main content
- Release notes: Use
--generate-notes for automatic changelog from commits
- Template labels: Use YAML frontmatter for auto-labeling issues/PRs
- User preference (ryzen): "gas maksimalkan" = comprehensive production-ready approach, not incremental patches
Example: mnemosyne-obsidian Transformation
Before (7/10):
- ✅ Good documentation
- ✅ Two installers
- ❌ No CI/CD
- ❌ No tests
- ❌ No templates
After (10/10):
- ✅ Excellent documentation
- ✅ Two installers (tested)
- ✅ CI/CD (GitHub Actions, passing)
- ✅ Test suite (6 tests, 100% pass)
- ✅ Issue templates (bug, feature)
- ✅ PR template
- ✅ CHANGELOG.md
- ✅ GitHub release (v1.1.0)
- ✅ FAQ (10 questions)
- ✅ 5 badges
Time: 1.5 hours
Commits: 3 commits
Lines: 288 lines added
Result: Production-ready, world-class repo
Full case study: See references/mnemosyne-obsidian-case-study.md for detailed breakdown, lessons learned, and reusable patterns.
Quick Checklist
1---2name: repo-quality-maksimalisasi3description: Evaluate and maximize GitHub repo quality from 7/10 to 10/10 perfect4version: 1.0.05author: Hermes Agent6license: MIT7metadata:8 source: https://skillmd.com/skills/kevinnft/repo-quality-maksimalisasi9 hermes:10 tags: [GitHub, Quality, CI/CD, Testing, Documentation, Templates]11 related_skills: [github-repo-management, github-pr-workflow]12origin: original13source_repo: kevinnft/ai-agent-skills14source_url: https://github.com/kevinnft/ai-agent-skills15source_license: MIT16language: en17---1819# Repository Quality Evaluation & Maksimalisasi2021Transform GitHub repos from good (7/10) to perfect (10/10) production-ready state.2223## When to Use2425- User says "gas maksimalkan" or "pastikan perfect"26- Repo needs professional polish for public release27- Want comprehensive CI/CD, tests, and templates28- Preparing repo for community contributions2930## Quality Scoring Framework3132Evaluate across 10 categories (0-10 each):3334| Category | Weight | What to Check |35|----------|--------|---------------|36| **Documentation** | 10% | README completeness, examples, architecture docs |37| **Installers/Setup** | 10% | Automated setup, clear instructions, idempotent |38| **Templates** | 5% | Starter files, boilerplate, examples |39| **CI/CD** | 15% | GitHub Actions, automated testing, status badges |40| **Examples** | 5% | Screenshots, demos, video tutorials |41| **Badges** | 5% | CI, license, version, stars, forks |42| **Changelog** | 10% | CHANGELOG.md, semantic versioning, release notes |43| **Releases** | 10% | GitHub releases, tags, versioned artifacts |44| **Issue Templates** | 15% | Bug report, feature request, PR templates |45| **Tests** | 15% | Test suite, coverage, automated validation |4647**Scoring:**48- 0-3: Missing or broken49- 4-6: Basic/minimal50- 7-8: Good/functional51- 9-10: Excellent/comprehensive5253**Total Score = Average of all categories**5455---5657## Maksimalisasi Workflow5859### Phase 1: CHANGELOG + Release (15 min)60611. **Create CHANGELOG.md**62 ```bash63 cat > CHANGELOG.md << 'EOF'64 # Changelog65 66 ## [1.1.0] - YYYY-MM-DD67 ### Added68 - Feature A69 - Feature B70 71 ## [1.0.0] - YYYY-MM-DD72 ### Added73 - Initial release74 EOF75 ```76772. **Create GitHub release**78 ```bash79 git tag -a v1.1.0 -m "v1.1.0 - Description"80 git push origin v1.1.081 gh release create v1.1.0 --title "v1.1.0 - Title" --notes "Release notes"82 ```8384### Phase 2: Badges + FAQ (20 min)85863. **Add badges to README**87 ```markdown88 [](https://github.com/owner/repo/actions)89 [](https://opensource.org/licenses/MIT)90 [](https://github.com/owner/repo/releases)91 [](https://github.com/owner/repo/stargazers)92 [](https://github.com/owner/repo/network/members)93 ```94954. **Add FAQ section** (before Contributing)96 ```markdown97 ## ❓ FAQ98 99 ### **Q: Common question 1?**100 **A:** Clear answer with examples.101 102 ### **Q: Common question 2?**103 **A:** Clear answer with code snippets.104 105 [Add 8-10 questions based on user feedback]106 ```107108### Phase 3: CI/CD + Tests (40 min)1091105. **Create GitHub Actions workflow**111 ```yaml112 # .github/workflows/ci.yml113 name: CI114 115 on:116 push:117 branches: [ main ]118 pull_request:119 branches: [ main ]120 121 jobs:122 test:123 runs-on: ubuntu-latest124 125 steps:126 - uses: actions/checkout@v3127 128 - name: Check Bash syntax129 run: |130 for script in *.sh; do131 bash -n "$script"132 done133 134 - name: Validate documentation135 run: |136 test -f README.md || exit 1137 test -f CHANGELOG.md || exit 1138 test -f LICENSE || exit 1139 140 - name: Run tests141 run: |142 if [ -f tests/test.sh ]; then143 ./tests/test.sh144 fi145 ```1461476. **Create test suite**148 ```bash149 mkdir -p tests150 cat > tests/test.sh << 'EOF'151 #!/bin/bash152 set -e153 154 echo "=== Running Tests ==="155 156 # Test 1: Syntax validation157 echo "Test 1: Syntax validation..."158 bash -n script.sh && echo "✅ Syntax OK" || exit 1159 160 # Test 2: File existence161 echo "Test 2: Required files..."162 test -f README.md && echo "✅ README exists" || exit 1163 164 # Test 3: Documentation completeness165 echo "Test 3: Documentation..."166 grep -q "Quick Start" README.md && echo "✅ Has Quick Start" || exit 1167 168 echo "✅ ALL TESTS PASSED!"169 EOF170 chmod +x tests/test.sh171 ```1721737. **Verify CI passes**174 ```bash175 git add .github/workflows/ci.yml tests/176 git commit -m "feat: add CI/CD and test suite"177 git push178 # Wait for CI to pass179 gh run list --limit 1180 ```181182### Phase 4: Templates (15 min)1831848. **Bug report template**185 ```bash186 mkdir -p .github/ISSUE_TEMPLATE187 cat > .github/ISSUE_TEMPLATE/bug_report.md << 'EOF'188 ---189 name: Bug report190 about: Create a report to help us improve191 title: '[BUG] '192 labels: bug193 ---194 195 ## 🐛 Bug Description196 Clear description of the bug.197 198 ## 📋 To Reproduce199 Steps to reproduce:200 1. Run command '...'201 2. See error '...'202 203 ## ✅ Expected Behavior204 What you expected to happen.205 206 ## 💻 Environment207 - OS: [e.g. Ubuntu 24.04]208 - Version: [e.g. 1.0.0]209 210 ## 🔍 Error Logs211 ```212 Paste logs here213 ```214 EOF215 ```2162179. **Feature request template**218 ```bash219 cat > .github/ISSUE_TEMPLATE/feature_request.md << 'EOF'220 ---221 name: Feature request222 about: Suggest an idea223 title: '[FEATURE] '224 labels: enhancement225 ---226 227 ## 🚀 Feature Description228 Clear description of the feature.229 230 ## 💡 Motivation231 Why is this needed?232 233 ## 📋 Proposed Solution234 How should it work?235 236 ## ✅ Acceptance Criteria237 - [ ] Criterion 1238 - [ ] Criterion 2239 EOF240 ```24124210. **PR template**243 ```bash244 cat > .github/pull_request_template.md << 'EOF'245 ## 📋 Description246 Brief description of changes.247 248 ## 🎯 Type of Change249 - [ ] 🐛 Bug fix250 - [ ] ✨ New feature251 - [ ] 💥 Breaking change252 - [ ] 📝 Documentation253 254 ## ✅ Checklist255 - [ ] Code follows style guidelines256 - [ ] Self-review completed257 - [ ] Documentation updated258 - [ ] Tests pass259 EOF260 ```261262---263264## Pitfalls2652661. **Don't skip CI verification**: Always wait for CI to pass before declaring complete2672. **Test idempotency**: Installers should be safe to run multiple times2683. **Mock dependencies in tests**: CI environment may not have all tools2694. **Badge order matters**: CI badge first (shows quality), then license, version, social proof2705. **FAQ placement**: Before Contributing section, after main content2716. **Release notes**: Use `--generate-notes` for automatic changelog from commits2727. **Template labels**: Use YAML frontmatter for auto-labeling issues/PRs2738. **User preference (ryzen)**: "gas maksimalkan" = comprehensive production-ready approach, not incremental patches274275---276277## Example: mnemosyne-obsidian Transformation278279**Before (7/10):**280- ✅ Good documentation281- ✅ Two installers282- ❌ No CI/CD283- ❌ No tests284- ❌ No templates285286**After (10/10):**287- ✅ Excellent documentation288- ✅ Two installers (tested)289- ✅ CI/CD (GitHub Actions, passing)290- ✅ Test suite (6 tests, 100% pass)291- ✅ Issue templates (bug, feature)292- ✅ PR template293- ✅ CHANGELOG.md294- ✅ GitHub release (v1.1.0)295- ✅ FAQ (10 questions)296- ✅ 5 badges297298**Time:** 1.5 hours 299**Commits:** 3 commits 300**Lines:** 288 lines added 301**Result:** Production-ready, world-class repo302303**Full case study:** See `references/mnemosyne-obsidian-case-study.md` for detailed breakdown, lessons learned, and reusable patterns.304305---306307## Quick Checklist308309- [ ] CHANGELOG.md created310- [ ] GitHub release published311- [ ] 5 badges added to README312- [ ] FAQ section added (10+ questions)313- [ ] GitHub Actions CI workflow314- [ ] Test suite created and passing315- [ ] Bug report template316- [ ] Feature request template317- [ ] PR template318- [ ] CI badge shows passing status