diff --git a/.github/MAINTENANCE.md b/.github/MAINTENANCE.md index 5f70613a..548ce0be 100644 --- a/.github/MAINTENANCE.md +++ b/.github/MAINTENANCE.md @@ -330,6 +330,129 @@ Preflight verification → Changelog → `npm run release:prepare -- X.Y.Z` → gh issue close --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: + +1. 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. +2. 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` +3. Keep the first paragraph readable to someone arriving from Google or GitHub Releases. +4. Prefer plain ASCII section headers in release notes. +5. 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: + +```markdown +## [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. +``` + +### Social Preview + +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: + +1. Open the repository on GitHub. +2. Go to **Settings**. +3. Open the **Social preview** section. +4. 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: + +~~~markdown +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 | diff --git a/README.md b/README.md index e5700150..0909d38c 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,12 @@ Antigravity Awesome Skills is a GitHub repository and installer CLI for reusable [![Cursor](https://img.shields.io/badge/Cursor-AI%20IDE-orange)](https://cursor.sh) [![Codex CLI](https://img.shields.io/badge/Codex%20CLI-OpenAI-green)](https://github.com/openai/codex) [![Gemini CLI](https://img.shields.io/badge/Gemini%20CLI-Google-blue)](https://github.com/google-gemini/gemini-cli) +[![Latest Release](https://img.shields.io/github/v/release/sickn33/antigravity-awesome-skills?display_name=tag&style=for-the-badge)](https://github.com/sickn33/antigravity-awesome-skills/releases/latest) +[![Install with NPX](https://img.shields.io/badge/Install-npx%20antigravity--awesome--skills-black?style=for-the-badge&logo=npm)](#installation) +[![Kiro](https://img.shields.io/badge/Kiro-AWS-orange?style=for-the-badge)](https://kiro.dev) +[![Copilot](https://img.shields.io/badge/Copilot-GitHub-lightblue?style=for-the-badge)](https://github.com/features/copilot) +[![OpenCode](https://img.shields.io/badge/OpenCode-CLI-gray?style=for-the-badge)](https://github.com/opencode-ai/opencode) +[![Antigravity](https://img.shields.io/badge/Antigravity-AI%20IDE-red?style=for-the-badge)](https://github.com/sickn33/antigravity-awesome-skills) **Current release: V8.3.0.** Trusted by 25k+ GitHub stargazers, this repository combines official and community skill collections with bundles, workflows, installation paths, and docs that help you go from first install to daily use quickly. diff --git a/docs/maintainers/repo-growth-seo.md b/docs/maintainers/repo-growth-seo.md index d6741597..5d18a15d 100644 --- a/docs/maintainers/repo-growth-seo.md +++ b/docs/maintainers/repo-growth-seo.md @@ -26,6 +26,12 @@ Preferred homepage: > `https://github.com/sickn33/antigravity-awesome-skills` +Preferred social preview: + +- use a clean preview image that says `1,273+ Agentic Skills`; +- mention Claude Code, Cursor, Codex CLI, and Gemini CLI; +- avoid dense text and tiny logos that disappear in social cards. + Preferred topics: - `agentic-skills` @@ -64,6 +70,45 @@ Suggested opening structure: 2. top changes that matter to new and returning users; 3. links to install, bundles, workflows, and relevant comparison pages if needed. +Suggested release template: + +```md +## [VERSION] - YYYY-MM-DD - "User-facing title" + +> Installable skill library update for Claude Code, Cursor, Codex CLI, Gemini CLI, and related AI coding assistants. + +Start here: + +- Install: `npx antigravity-awesome-skills` +- Choose your tool: `README.md#choose-your-tool` +- Best skills by tool: `README.md#best-skills-by-tool` +- Bundles: `docs/users/bundles.md` +- Workflows: `docs/users/workflows.md` + +## What's new + +- New skills with clear use-case language +- New bundles, workflows, or onboarding docs +- New tool support or compatibility improvements + +## Improvements + +- Reliability and installer updates +- Quality, validation, or metadata updates +- Security or maintenance work that affects users + +## Who should care + +- Claude Code users +- Cursor users +- Codex CLI users +- Gemini CLI users + +## Credits + +- Contributors and merged PRs +``` + ## Discussions checklist Suggested pinned discussion topics: