firefrost-gaming/antigravity-skills-reference

Files

sickn33 2495de1544 docs(growth): refine repo onboarding guidance

2026-03-19 18:14:25 +01:00

22 KiB

Raw Blame History

🛠️ Repository Maintenance Guide (V5)

"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.

Maintainer shortcuts: Merge a PR · Reopen & merge a closed PR · Post-merge & contributors · Close issues · Create a release

0. 🤖 Agent Protocol (THE BIBLE)

AGENTS MUST READ AND FOLLOW THIS SECTION BEFORE MARKING ANY TASK AS COMPLETE.

There are 3 things that usually fail/get forgotten. DO NOT FORGET THEM:

1. 📤 ALWAYS PUSH (Non-Negotiable)

Committing is NOT enough. You must PUSH to the remote.

BAD: git commit -m "feat: new skill" (User sees nothing)
GOOD: git commit -m "..." && git push origin main

2. 🔄 SYNC GENERATED FILES (Avoid CI Drift)

If you touch any of these:

skills/ (add/remove/modify skills)
the Full Skill Registry section of README.md
counts/claims about the number of skills (1,200+ Agentic Skills..., (1,200+/1,200+), etc.)

…then you MUST run the Validation Chain BEFORE committing.

Running npm run chain is NOT optional.
Running npm run catalog is NOT optional.

For contributor PRs, the contract is now source-only:

contributors should not commit CATALOG.md, skills_index.json, or data/*.json
PR CI previews generated drift but does not require those files in the branch
main remains the only canonical owner of derived registry artifacts

If main CI fails with:

❌ Detected uncommitted changes produced by registry/readme/catalog scripts.

it means the repository could not auto-sync generated artifacts cleanly and maintainer intervention is required.

3. 📝 EVIDENCE OF WORK

You must create/update walkthrough.md or CHANGELOG.md to document what changed.
If you made something new, link it in the artifacts.

4. 🚫 NO BRANCHES

ALWAYS use the main branch.
NEVER create feature branches (e.g., feat/new-skill).
We commit directly to main to keep history linear and simple.

1. 🚦 Daily Maintenance Routine

A. Validation Chain

Before ANY commit that adds/modifies skills, run the chain:

Validate, index, and update readme:
```
npm run chain
```
Must return 0 errors for new skills.
Build catalog:
```
npm run catalog
```
COMMIT GENERATED FILES:
```
git add README.md skills_index.json data/skills_index.json data/catalog.json data/bundles.json data/aliases.json CATALOG.md
git commit -m "chore: sync generated files"
```
🔴 CRITICAL for direct main work: If you skip this on maintainer work that lands directly on main, CI will fail with "Detected uncommitted changes". For contributor PRs, do not include derived registry artifacts. CI blocks direct edits to those files and previews drift separately. See docs/maintainers/ci-drift-fix.md for details.

B. When You Merge a PR (Step-by-Step)

Agent instruction (when analyzing or handling PRs): Always merge accepted PRs via GitHub (Squash and merge). Never integrate locally and then close the PR. If a PR is closed but its changes were integrated locally, reopen it and follow Reopen & merge so it ends up Merged. Contributors must get credit.

Before merging:

CI is green — Validation, reference checks, tests, and generated artifact steps passed (see .github/workflows/ci.yml). If the PR changes any SKILL.md, the separate skill-review workflow must also be green.
Generated drift understood — On pull requests, generator drift is informational only. Do not block a good PR solely because canonical artifacts would be regenerated. Also do not accept PRs that directly edit CATALOG.md, skills_index.json, or data/*.json; those files are main-owned.
Quality Bar — PR description confirms the Quality Bar Checklist (metadata, risk label, credits if applicable).
Issue link — If the PR fixes an issue, the PR description should contain Closes #N or Fixes #N so GitHub auto-closes the issue on merge.

How you merge:

Always merge via GitHub so the PR shows as Merged and the contributor gets credit. Use "Squash and merge". Do not integrate locally and then close the PR — that would show "Closed" and the contributor would not get proper attribution.
If the PR has merge conflicts: Resolve them on the PR branch (you or the contributor: merge main into the PR branch, fix conflicts, drop derived registry files from the branch if they appear, push). For generated registry files, prefer keeping main's side rather than hand-editing conflicts. Then use "Squash and merge" on GitHub. Full steps: docs/maintainers/merging-prs.md.
Rare exception: Only if merging via GitHub is not possible, you may integrate locally and close the PR; in that case you must add a Co-authored-by line to the commit and explain in a comment. Prefer to avoid this so PRs are always Merged.

If CI is blocked on fork approval or stale PR metadata:

This happens regularly on community PRs from forks. The common symptoms are:

gh pr checks shows no checks reported even though Actions runs exist.
gh run list shows action_required with jobs: [] for Skills Registry CI or Skill Review.
pr-policy fails with PR body must include the Quality Bar Checklist from the template. even after you corrected the PR body and hit rerun.

Use this playbook:

Approve waiting fork runs using the run id(s) from gh run list:

gh api -X POST repos/<OWNER>/<REPO>/actions/runs/<RUN_ID>/approve

Normalize the PR body so it includes the repository template's ## Quality Bar Checklist ✅ section. If gh pr edit works, use it. If gh pr edit fails with the GraphQL projectCards / Projects Classic deprecation error, patch the PR body through the REST API instead:
```
gh api repos/<OWNER>/<REPO>/pulls/<PR_NUMBER> -X PATCH --input <(jq -n --rawfile body /tmp/pr_body.md '{body:$body}')
```
Do not trust a plain rerun to pick up the updated PR body. In practice, gh run rerun <RUN_ID> may re-use the original pull_request event payload, so pr-policy can keep reading the stale body and fail again.

If the rerun still sees stale metadata, close and reopen the PR to force a fresh pull_request event:

gh pr close <PR_NUMBER> --comment "Maintainer workflow refresh: closing and reopening to retrigger pull_request checks against the updated PR body."
gh pr reopen <PR_NUMBER>

Approve the newly created fork runs after reopen. They will usually appear as a fresh pair of action_required runs for Skills Registry CI and Skill Review.
Wait for the new checks only. You may see older failed pr-policy runs in the rollup alongside newer green runs. Merge only after the fresh run set for the current PR state is fully green: pr-policy, source-validation, artifact-preview, and review when SKILL.md changed.
If gh pr merge says Base branch was modified, refresh the PR state and retry. This is normal when you are merging a batch and main moved between attempts.

If a PR was closed after local integration (reopen and merge):

If a PR was integrated via local squash and then closed (so it shows "Closed" instead of "Merged"), you can still give the contributor credit by reopening it and merging it on GitHub. The merge can be effectively "empty" (no new diff vs main); what matters is that the PR ends up Merged.

Reopen the PR on GitHub (Reopen button on the closed PR page), or: gh pr reopen <PR_NUMBER>.

Fetch the PR branch (the branch lives on the contributor's fork):

git fetch origin pull/<PR_NUMBER>/head:pr-<PR_NUMBER>-tmp
git checkout pr-<PR_NUMBER>-tmp

Merge main into it and resolve conflicts:
```
git merge origin/main -m "chore: merge main to resolve conflicts"
```
For conflicts in generated/registry files (CATALOG.md, data/catalog.json, etc.), keep main's version and remove those derived files from the PR branch: git checkout --theirs CATALOG.md data/catalog.json (and any other derived files), then git add them.
Commit the merge (if not already done):
git commit -m "chore: merge main to resolve conflicts" --no-edit
Push to the contributor's fork. Add their fork as a remote if needed (replace USER and BRANCH with the PR head owner and branch from the PR page):
```
git remote add <user>-fork https://github.com/<USER>/antigravity-awesome-skills.git
git push <user>-fork pr-<PR_NUMBER>-tmp:<BRANCH>
```
This works if the contributor enabled "Allow edits from maintainers" (or you have push access). If push is denied, ask the contributor to merge main into their branch and push; then you use "Squash and merge" on GitHub.
Merge the PR on GitHub:
gh pr merge <PR_NUMBER> --squash
The PR will show as Merged and the contributor will get credit.
Switch back to main:
git checkout main

We used this flow for PRs #220, #224, and #225 after they had been integrated locally and closed.

Right after merging:

If the PR had Closes #N — The issue is closed automatically; no extra action.
If an issue was fixed but not linked — Close it manually and add a comment, e.g.:
```
Fixed in #<PR_NUMBER>. Shipped in release vX.Y.Z.
```
Single PR or small batch — Optionally run the full Post-Merge Routine below. For a single, trivial PR you can defer it to the next release prep.

C. Post-Merge Routine (Must Do Before a Release)

After you have merged several PRs or before cutting a release:

Sync Contributors List:
- Run: git shortlog -sn --all
- Update ## Repo Contributors in README.md.
Verify Table of Contents:
- Ensure all new headers have clean anchors.
- NO EMOJIS in H2 headers.
Prepare for release — Draft the release and tag when ready (see §4 Release Workflow below).

2. 📝 Documentation "Pixel Perfect" Rules

We discovered several consistency issues during V4 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)
docs/users/getting-started.md (Beginner Guide)
docs/users/faq.md (Troubleshooting)

Common pitfall: Updating the clone URL in README but leaving an old one in FAQ.

C. Statistics Consistency (CRITICAL)

If you add/remove skills, you MUST ensure generated counts and user-facing claims stay aligned.

Locations to check:

README.md
package.json description
skills_index.json and generated catalog artifacts
Any user docs that deliberately hardcode counts

D. Credits Policy (Who goes where?)

Credits & Sources: Use this for External Repos.
- Rule: "I extracted skills from this link you sent me." -> Add to ## Credits & Sources.
Repo Contributors: Use this for Pull Requests.
- Rule: "This user sent a PR." -> Add to ## Repo Contributors.

E. Badges & Links

Antigravity Badge: Must point to https://github.com/sickn33/antigravity-awesome-skills, NOT anthropics/antigravity.
License: Ensure the link points to LICENSE file.

F. Workflows Consistency (NEW in V5)

If you touch any Workflows-related artifact, keep all workflow surfaces in sync:

docs/users/workflows.md (human-readable playbooks)
data/workflows.json (machine-readable schema)
skills/antigravity-workflows/SKILL.md (orchestration entrypoint)

Rules:

Every workflow id referenced in docs must exist in data/workflows.json.
If you add/remove a workflow step category, update prompt examples accordingly.
If a workflow references optional skills not yet merged (example: go-playwright), mark them explicitly as optional in docs.
If workflow onboarding text is changed, update the docs trinity:
- README.md
- docs/users/getting-started.md
- docs/users/faq.md

3. 🛡️ Governance & Quality Bar

A. The 6-Point Quality Check

Reject any PR that fails this:

Metadata: Has name, description?
Safety: risk: offensive used for red-team tools?
Clarity: Does it say when to use it?
Examples: Copy-pasteable code blocks?
Risk Limits: If the skill includes shell/network/filesystem/mutation guidance, instructions include explicit prerequisites and warnings.
Repo Security Scan: Run npm run security:docs for command-heavy, network-execution, or token-like guidance in SKILL.md.

B. Risk Labels (V4)

⚪ Safe: Default.
🔴 Risk: Destructive/Security tools. MUST have [Authorized Use Only] warning.
🟣 Official: Vendor mirrors only.

4. 🚀 Release Workflow

When cutting a new version, follow the maintainer playbook in docs/maintainers/release-process.md.

Release checklist (order matters):
Preflight verification → Changelog → npm run release:prepare -- X.Y.Z → npm run release:publish -- X.Y.Z → npm publish (manual or via CI) → Close remaining linked issues.

Run release verification:

npm run release:preflight

Optional diagnostic pass:

npm run validate:strict

Update Changelog: Add the new release section to CHANGELOG.md.
Prepare commit and tag locally:
```
npm run release:prepare -- X.Y.Z
```
This validates the release, aligns versioned files, writes the release notes artifact, creates the release commit, and creates the local tag.
Create GitHub Release (REQUIRED):

⚠️ CRITICAL: Pushing a tag (git push --tags) is NOT enough. You must create a GitHub Release Object for it to appear in the sidebar and trigger the NPM publish workflow.

Use the GitHub CLI:
```
npm run release:publish -- X.Y.Z
```
Important: The release tag must match package.json's version. The Publish to npm workflow runs on Release published and will run npm publish; npm rejects republishing the same version.

Or create the release manually via GitHub UI > Releases > Draft a new release, then publish.
Publish to npm (so npx antigravity-awesome-skills works):
- Option A (manual): From repo root, with npm logged in and 2FA/token set up:
```
npm publish
```
  You cannot republish the same version; always bump package.json before publishing.
- Option B (CI): On GitHub, create a Release (tag e.g. v4.6.1). The workflow Publish to npm runs on Release published and runs npm publish if the repo secret NPM_TOKEN is set (npm → Access Tokens → Granular token with Publish, then add as repo secret NPM_TOKEN).
Close linked issue(s):
- Issues that had Closes #N / Fixes #N in a merged PR are already closed.
- For any issue that was fixed by the release but not auto-closed, close it manually and add a comment, e.g.:
```
gh issue close <ID> --comment "Shipped in vX.Y.Z. See CHANGELOG.md and release notes."
```

GitHub Release Notes Requirements

Every published GitHub Release should work as a discovery page, not just an internal changelog dump.

Required rules:

Put the user-facing tool language early:
- mention Claude Code, Cursor, Codex CLI, Gemini CLI, or the specific supported tools that matter for that release.
Add a short "Start here" block near the top:
- install command
- link to README.md#choose-your-tool
- link to README.md#best-skills-by-tool
- link to docs/users/bundles.md
- link to docs/users/workflows.md
Keep the first paragraph readable to someone arriving from Google or GitHub Releases.
Prefer plain ASCII section headers in release notes.
Do not rewrite historical releases in bulk. Improve the latest release and all future releases.

GitHub Release Notes Template

Use this structure for the published GitHub Release object:

## [X.Y.Z] - YYYY-MM-DD - "User-facing title"

> Installable skill library update for Claude Code, Cursor, Codex CLI, Gemini CLI, Antigravity, and related AI coding assistants.

Start here:

- Install: `npx antigravity-awesome-skills`
- Choose your tool: [README -> Choose Your Tool](https://github.com/sickn33/antigravity-awesome-skills#choose-your-tool)
- Best skills by tool: [README -> Best Skills By Tool](https://github.com/sickn33/antigravity-awesome-skills#best-skills-by-tool)
- Bundles: [docs/users/bundles.md](https://github.com/sickn33/antigravity-awesome-skills/blob/main/docs/users/bundles.md)
- Workflows: [docs/users/workflows.md](https://github.com/sickn33/antigravity-awesome-skills/blob/main/docs/users/workflows.md)

[Brief paragraph explaining what changed and who the release helps.]

## New Skills

- **skill-name** - user-facing summary

## Improvements

- **Area**: user-facing improvement summary

## Who should care

- **Claude Code users** ...
- **Cursor users** ...
- **Codex CLI users** ...
- **Gemini CLI users** ...

## Credits

- **@username** for `skill-name`

Upgrade now: `git pull origin main` to fetch the latest skills.

If you set a repository social preview image on GitHub, keep these rules:

focus on the core value proposition;
mention the primary supported tools when helpful;
avoid dense text or tiny unreadable logos;
refresh it when repository positioning changes materially.

Manual upload path on GitHub:

Open the repository on GitHub.
Go to Settings.
Open the Social preview section.
Upload the image you want to use.

Pinned Discussion Template

Canonical onboarding discussion:

Title: Start here: best skills by tool
Current live discussion: https://github.com/sickn33/antigravity-awesome-skills/discussions/361

When refreshing or recreating the pinned onboarding discussion, keep this structure:

If you are new to **Antigravity Awesome Skills**, start here instead of browsing all skills at random.

## Install in 1 minute

```bash
npx antigravity-awesome-skills
```

## Best starting pages by tool

- Claude Code
- Cursor
- Codex CLI
- Gemini CLI

## Start with a bundle

- Bundles
- Workflows
- Getting started
- Usage guide

## Best starter skills for most users

- `@brainstorming`
- `@lint-and-validate`
- `@systematic-debugging`
- `@create-pr`
- `@security-auditor`

## Compare before you install

- comparison pages
- best-of pages

If GitHub does not support pinning via API, create/update the discussion programmatically if possible and pin it manually in the UI.

When to Close an Issue

Situation	Action
PR merges and PR body contains `Closes #N` or `Fixes #N`	GitHub closes the issue automatically.
PR merges but did not reference the issue	After merge, close manually: `gh issue close N --comment "Fixed in #<PR>. Shipped in vX.Y.Z."`
Fix/feature shipped in a release, no PR referenced	Close with: `gh issue close N --comment "Shipped in vX.Y.Z. See CHANGELOG."`

📋 Changelog Entry Template

Each new release section in CHANGELOG.md should follow Keep a Changelog and this structure:

## [X.Y.Z] - YYYY-MM-DD - "[Theme Name]"

> **[One-line catchy summary of the release]**

[Brief 2-3 sentence intro about the release's impact]

## 🚀 New Skills

### [Emoji] [Skill Name](skills/skill-name/)

**[Bold high-level benefit]**
[Description of what it does]

- **Key Feature 1**: [Detail]
- **Key Feature 2**: [Detail]

> **Try it:** `(User Prompt) ...`

---

## 📦 Improvements

- **Registry Update**: Now tracking [N] skills.
- **[Component]**: [Change detail]

## 👥 Credits

A huge shoutout to our community contributors:

- **@username** for `skill-name`
- **@username** for `fix-name`

---

_Upgrade now: `git pull origin main` to fetch the latest skills._

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 of SKILL.md.
Push Immediately.

6. 📁 Data directory note

data/package.json exists for historical reasons; the build and catalog scripts run from the repo root and use root node_modules. You can ignore or remove data/package.json and data/node_modules if present.

22 KiB Raw Blame History