chore: standardize maintenance rules and sync docs (v3.3.0 audit)
This commit is contained in:
99
.github/MAINTENANCE.md
vendored
99
.github/MAINTENANCE.md
vendored
@@ -7,6 +7,41 @@ It covers the **Quality Bar**, **Documentation Consistency**, and **Release Work
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## 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 `skills/`, you **MUST** run the validation chain.
|
||||||
|
|
||||||
|
- Running `validate_skills.py` is NOT optional.
|
||||||
|
- Running `generate_index.py` is NOT optional.
|
||||||
|
- Running `update_readme.py` is NOT optional.
|
||||||
|
_If CI fails because of drift, you have failed._
|
||||||
|
|
||||||
|
### 3. 📝 EVIDENCE OF WORK
|
||||||
|
|
||||||
|
- You must create/update `walkthrough.md` or `RELEASE_NOTES.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
|
## 1. 🚦 Daily Maintenance Routine
|
||||||
|
|
||||||
### A. Validation Chain
|
### A. Validation Chain
|
||||||
@@ -84,15 +119,25 @@ If you update installation instructions or tool compatibility, you MUST update a
|
|||||||
|
|
||||||
_Common pitfall: Updating the clone URL in README but leaving an old one in FAQ._
|
_Common pitfall: Updating the clone URL in README but leaving an old one in FAQ._
|
||||||
|
|
||||||
### C. Statistics
|
### C. Statistics Consistency (CRITICAL)
|
||||||
|
|
||||||
If you add skills, update the counts:
|
If you add/remove skills, you **MUST** ensure the total count is identical in ALL locations.
|
||||||
|
**Do not allow drift** (e.g., 356 in title, 354 in header).
|
||||||
|
|
||||||
- Title of `README.md`: "253+ Agentic Skills..."
|
Locations to check:
|
||||||
- `## Full Skill Registry (253/253)` header.
|
|
||||||
- `GETTING_STARTED.md` intro.
|
|
||||||
|
|
||||||
### D. Badges & Links
|
1. **Title of `README.md`**: "356+ Agentic Skills..."
|
||||||
|
2. **`## Full Skill Registry (356/356)` header**.
|
||||||
|
3. **`GETTING_STARTED.md` intro**.
|
||||||
|
|
||||||
|
### 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`.
|
- **Antigravity Badge**: Must point to `https://github.com/sickn33/antigravity-awesome-skills`, NOT `anthropics/antigravity`.
|
||||||
- **License**: Ensure the link points to `LICENSE` file.
|
- **License**: Ensure the link points to `LICENSE` file.
|
||||||
@@ -132,6 +177,48 @@ When cutting a new version (e.g., V4):
|
|||||||
git push origin v3.0.0
|
git push origin v3.0.0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### 📋 Release Note Template
|
||||||
|
|
||||||
|
All changeslogs/release notes MUST follow this structure to ensure professionalism and quality:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
# Release vX.Y.Z: [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
|
## 5. 🚨 Emergency Fixes
|
||||||
|
|||||||
2
FAQ.md
2
FAQ.md
@@ -116,7 +116,7 @@ Use the `@` symbol followed by the skill name:
|
|||||||
|
|
||||||
### How do I know which skill to use?
|
### How do I know which skill to use?
|
||||||
|
|
||||||
1. **Browse the README**: Check the [Full Skill Registry](README.md#full-skill-registry-253253).
|
1. **Browse the README**: Check the [Full Skill Registry](README.md#full-skill-registry-255255).
|
||||||
2. **Search**: `ls skills/ | grep "keyword"`
|
2. **Search**: `ls skills/ | grep "keyword"`
|
||||||
3. **Ask your AI**: "What skills do you have for testing?"
|
3. **Ask your AI**: "What skills do you have for testing?"
|
||||||
|
|
||||||
|
|||||||
12
README.md
12
README.md
@@ -124,20 +124,12 @@ The repository is organized into several key areas of expertise:
|
|||||||
|
|
||||||
[Check out our Starter Packs in docs/BUNDLES.md](docs/BUNDLES.md) to find the perfect toolkit for your role.
|
[Check out our Starter Packs in docs/BUNDLES.md](docs/BUNDLES.md) to find the perfect toolkit for your role.
|
||||||
|
|
||||||
## Curated Collections
|
|
||||||
|
|
||||||
[Check out our Starter Packs in docs/BUNDLES.md](docs/BUNDLES.md) to find the perfect toolkit for your role.
|
|
||||||
|
|
||||||
## 📦 Curated Collections
|
|
||||||
|
|
||||||
[Check out our Starter Packs in docs/BUNDLES.md](docs/BUNDLES.md) to find the perfect toolkit for your role.
|
|
||||||
|
|
||||||
## Full Skill Registry (255/255)
|
## Full Skill Registry (255/255)
|
||||||
|
|
||||||
> [!NOTE] > **Document Skills**: We provide both **community** and **official Anthropic** versions for DOCX, PDF, PPTX, and XLSX. Locally, the official versions are used by default (via symlinks). In the repository, both versions are available for flexibility.
|
> [!NOTE] > **Document Skills**: We provide both **community** and **official Anthropic** versions for DOCX, PDF, PPTX, and XLSX. Locally, the official versions are used by default (via symlinks). In the repository, both versions are available for flexibility.
|
||||||
|
|
||||||
| Skill Name | Risk | Description | Path |
|
| Skill Name | Risk | Description | Path |
|
||||||
| :--- | :--- | :--- | :--- |
|
| :-------------------------------------------------- | :--- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------- |
|
||||||
| **2d-games** | ⚪ | 2D game development principles. Sprites, tilemaps, physics, camera. | `skills/game-development/2d-games` |
|
| **2d-games** | ⚪ | 2D game development principles. Sprites, tilemaps, physics, camera. | `skills/game-development/2d-games` |
|
||||||
| **3d-games** | ⚪ | 3D game development principles. Rendering, shaders, physics, cameras. | `skills/game-development/3d-games` |
|
| **3d-games** | ⚪ | 3D game development principles. Rendering, shaders, physics, cameras. | `skills/game-development/3d-games` |
|
||||||
| **3d-web-experience** | ⚪ | Expert in building 3D experiences for the web - Three.js, React Three Fiber, Spline, WebGL, and interactive 3D scenes. Covers product configurators, 3D portfolios, immersive websites, and bringing depth to web experiences. Use when: 3D website, three.js, WebGL, react three fiber, 3D experience. | `skills/3d-web-experience` |
|
| **3d-web-experience** | ⚪ | Expert in building 3D experiences for the web - Three.js, React Three Fiber, Spline, WebGL, and interactive 3D scenes. Covers product configurators, 3D portfolios, immersive websites, and bringing depth to web experiences. Use when: 3D website, three.js, WebGL, react three fiber, 3D experience. | `skills/3d-web-experience` |
|
||||||
@@ -334,7 +326,7 @@ The repository is organized into several key areas of expertise:
|
|||||||
| **senior-architect** | ⚪ | Comprehensive software architecture skill for designing scalable, maintainable systems using ReactJS, NextJS, NodeJS, Express, React Native, Swift, Kotlin, Flutter, Postgres, GraphQL, Go, Python. Includes architecture diagram generation, system design patterns, tech stack decision frameworks, and dependency analysis. Use when designing system architecture, making technical decisions, creating architecture diagrams, evaluating trade-offs, or defining integration patterns. | `skills/senior-architect` |
|
| **senior-architect** | ⚪ | Comprehensive software architecture skill for designing scalable, maintainable systems using ReactJS, NextJS, NodeJS, Express, React Native, Swift, Kotlin, Flutter, Postgres, GraphQL, Go, Python. Includes architecture diagram generation, system design patterns, tech stack decision frameworks, and dependency analysis. Use when designing system architecture, making technical decisions, creating architecture diagrams, evaluating trade-offs, or defining integration patterns. | `skills/senior-architect` |
|
||||||
| **senior-fullstack** | ⚪ | Comprehensive fullstack development skill for building complete web applications with React, Next.js, Node.js, GraphQL, and PostgreSQL. Includes project scaffolding, code quality analysis, architecture patterns, and complete tech stack guidance. Use when building new projects, analyzing code quality, implementing design patterns, or setting up development workflows. | `skills/senior-fullstack` |
|
| **senior-fullstack** | ⚪ | Comprehensive fullstack development skill for building complete web applications with React, Next.js, Node.js, GraphQL, and PostgreSQL. Includes project scaffolding, code quality analysis, architecture patterns, and complete tech stack guidance. Use when building new projects, analyzing code quality, implementing design patterns, or setting up development workflows. | `skills/senior-fullstack` |
|
||||||
| **seo-audit** | ⚪ | Diagnose and audit SEO issues affecting crawlability, indexation, rankings, and organic performance. Use when the user asks for an SEO audit, technical SEO review, ranking diagnosis, on-page SEO review, meta tag audit, or SEO health check. This skill identifies issues and prioritizes actions but does not execute changes. For large-scale page creation, use programmatic-seo. For structured data, use schema-markup. | `skills/seo-audit` |
|
| **seo-audit** | ⚪ | Diagnose and audit SEO issues affecting crawlability, indexation, rankings, and organic performance. Use when the user asks for an SEO audit, technical SEO review, ranking diagnosis, on-page SEO review, meta tag audit, or SEO health check. This skill identifies issues and prioritizes actions but does not execute changes. For large-scale page creation, use programmatic-seo. For structured data, use schema-markup. | `skills/seo-audit` |
|
||||||
| **seo-fundamentals** | ⚪ | Core principles of SEO including E-E-A-T, Core Web Vitals, technical foundations, content quality, and how modern search engines evaluate pages. This skill explains *why* SEO works, not how to execute specific optimizations. | `skills/seo-fundamentals` |
|
| **seo-fundamentals** | ⚪ | Core principles of SEO including E-E-A-T, Core Web Vitals, technical foundations, content quality, and how modern search engines evaluate pages. This skill explains _why_ SEO works, not how to execute specific optimizations. | `skills/seo-fundamentals` |
|
||||||
| **server-management** | ⚪ | Server management principles and decision-making. Process management, monitoring strategy, and scaling decisions. Teaches thinking, not commands. | `skills/server-management` |
|
| **server-management** | ⚪ | Server management principles and decision-making. Process management, monitoring strategy, and scaling decisions. Teaches thinking, not commands. | `skills/server-management` |
|
||||||
| **Shodan Reconnaissance and Pentesting** | ⚪ | This skill should be used when the user asks to "search for exposed devices on the internet," "perform Shodan reconnaissance," "find vulnerable services using Shodan," "scan IP ranges with Shodan," or "discover IoT devices and open ports." It provides comprehensive guidance for using Shodan's search engine, CLI, and API for penetration testing reconnaissance. | `skills/shodan-reconnaissance` |
|
| **Shodan Reconnaissance and Pentesting** | ⚪ | This skill should be used when the user asks to "search for exposed devices on the internet," "perform Shodan reconnaissance," "find vulnerable services using Shodan," "scan IP ranges with Shodan," or "discover IoT devices and open ports." It provides comprehensive guidance for using Shodan's search engine, CLI, and API for penetration testing reconnaissance. | `skills/shodan-reconnaissance` |
|
||||||
| **shopify-apps** | ⚪ | Expert patterns for Shopify app development including Remix/React Router apps, embedded apps with App Bridge, webhook handling, GraphQL Admin API, Polaris components, billing, and app extensions. Use when: shopify app, shopify, embedded app, polaris, app bridge. | `skills/shopify-apps` |
|
| **shopify-apps** | ⚪ | Expert patterns for Shopify app development including Remix/React Router apps, embedded apps with App Bridge, webhook handling, GraphQL Admin API, Polaris components, billing, and app extensions. Use when: shopify app, shopify, embedded app, polaris, app bridge. | `skills/shopify-apps` |
|
||||||
|
|||||||
Reference in New Issue
Block a user