3.8 KiB
🛠️ Repository Maintenance Guide (V3)
"If it's not documented, it's broken."
This guide details the exact procedures for maintaining antigravity-awesome-skills.
It covers the Quality Bar, Documentation Consistency, and Release Workflows.
1. 🚦 Daily Maintenance Routine
A. Validation Chain
Before ANY commit that adds/modifies skills, run the chain:
-
Validate Metadata & Quality:
python3 scripts/validate_skills.pyMust return 0 errors for new skills.
-
Regenerate Index: python3 scripts/generate_index.py
-
Update Readme:
python3 scripts/update_readme.py -
COMMIT GENERATED FILES:
git add skills_index.json README.md git commit -m "chore: sync generated files"🔴 CRITICAL: If you skip this, CI will fail with "Detected uncommitted changes". See docs/CI_DRIFT_FIX.md for details.
B. Post-Merge Routine (Must Do)
After multiple PR merges or significant changes:
-
Sync Contributors List:
- Run:
git shortlog -sn --all - Update
## Repo Contributorsin README.md.
- Run:
-
Verify Table of Contents:
- Ensure all new headers have clean anchors.
- NO EMOJIS in H2 headers.
-
Draft a Release:
- Go to Releases Page.
- Draft a new release for the merged changes.
- Tag version (e.g.,
v3.1.0).
2. 📝 Documentation "Pixel Perfect" Rules
We discovered several consistency issues during V3 development. Follow these rules STRICTLY.
A. Table of Contents (TOC) Anchors
GitHub's anchor generation breaks if headers have emojis.
- BAD:
## 🚀 New Here?-> Anchor:#--new-here(Broken) - GOOD:
## New Here?-> Anchor:#new-here(Clean)
Rule: NEVER put emojis in H2 (##) headers. Put them in the text below if needed.
B. The "Trinity" of Docs
If you update installation instructions or tool compatibility, you MUST update all 3 files:
README.md(Source of Truth)GETTING_STARTED.md(Beginner Guide)FAQ.md(Troubleshooting)
Common pitfall: Updating the clone URL in README but leaving an old one in FAQ.
C. Statistics
If you add skills, update the counts:
- Title of
README.md: "253+ Agentic Skills..." ## Full Skill Registry (253/253)header.GETTING_STARTED.mdintro.
D. Badges & Links
- Antigravity Badge: Must point to
https://github.com/sickn33/antigravity-awesome-skills, NOTanthropics/antigravity. - License: Ensure the link points to
LICENSEfile.
3. 🛡️ Governance & Quality Bar
A. The 5-Point Quality Check
Reject any PR that fails this:
- Metadata: Has
name,description? - Safety:
risk: offensiveused for red-team tools? - Clarity: Does it say when to use it?
- Examples: Copy-pasteable code blocks?
- Actions: "Run this command" vs "Think about this".
B. Risk Labels (V3)
- ⚪ Safe: Default.
- 🔴 Risk: Destructive/Security tools. MUST have
[Authorized Use Only]warning. - 🟣 Official: Vendor mirrors only.
4. 🚀 Release Workflow
When cutting a new version (e.g., V4):
- Run Full Validation:
python3 scripts/validate_skills.py --strict - Update Changelog: Create
RELEASE_NOTES.md. - Bump Version: Update header in
README.md. - Tag Release:
git tag -a v3.0.0 -m "V3 Enterprise Edition" git push origin v3.0.0
5. 🚨 Emergency Fixes
If a skill is found to be harmful or broken:
- Move to broken folder (don't detect):
mv skills/bad-skill skills/.broken/ - Or Add Warning: Add
> [!WARNING]to the top ofSKILL.md. - Push Immediately.