ayrisdev/app-store-optimization
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: restore VERY detailed documentation while keeping V3 updates [skip ci]

Browse Source
This commit is contained in:
sck_0
2026-01-25 20:17:00 +01:00
parent 45e2049663
commit e242186fe2
2 changed files with 287 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

212
CONTRIBUTING.md
View File

@@ -1,7 +1,7 @@
# 🤝 Contributing Guide - V3 Enterprise Edition
**Thank you for wanting to help!** This repository is built by the community, for the community.
With V3, we raised the bar for quality. This guide covers everything from your first Pull Request to our new Quality Standards.
**Thank you for wanting to make this repo better!** This guide shows you exactly how to contribute, even if you're new to open source.
With V3, we raised the bar for quality. Please read the **new Quality Standards** below carefully.
---
@@ -17,74 +17,102 @@ With V3, we raised the bar for quality. This guide covers everything from your f
---
## 🛠️ Ways to Contribute
## Ways to Contribute
You don't need to be an expert! Here are ways anyone can help:
### 1. Improve Documentation
### 1. Improve Documentation (Easiest!)
- Fix typos or grammar
- Make explanations clearer
- Add examples to existing skills
- Translate documentation
- Translate documentation to other languages
### 2. Create New Skills
### 2. Report Issues
- Found something confusing? Tell us!
- Skill not working? Let us know!
- Have suggestions? We want to hear them!
### 3. Create New Skills
- Share your expertise as a skill
- Fill gaps in the current collection
- Improve existing skills
### 3. Report Issues
### 4. Test and Validate
- Found a bug? [Open an issue](https://github.com/sickn33/antigravity-awesome-skills/issues)
- Try skills and report what works/doesn't work
- Test on different AI tools
- Suggest improvements
---
## 🚀 Step-by-Step: Create Your First Skill
## How to Create a New Skill
### Step 1: Fork & Clone
### Step-by-Step Guide
#### Step 1: Choose Your Skill Topic
Ask yourself: "What do I wish my AI assistant knew better?".
Example: "I'm good at Docker, let me create a Docker skill".
#### Step 2: Create the Folder Structure
Skills live in the `skills/` directory. Use `kebab-case` for folder names.
```bash
git clone https://github.com/YOUR-USERNAME/antigravity-awesome-skills.git
cd antigravity-awesome-skills
# Navigate to skills
cd skills/
# Create your skill folder
mkdir my-awesome-skill
cd my-awesome-skill
# Create the SKILL.md file
touch SKILL.md
```
### Step 2: Create the Folder
#### Step 3: Write Your SKILL.md
Skills live in `skills/`. Names must be `kebab-case`.
```bash
# Good
mkdir skills/my-new-skill
# Bad
mkdir skills/MyNewSkill
```
### Step 3: Write the Content (`SKILL.md`)
Every skill needs this basic structure. Copy this template:
Every skill needs this basic structure. **Copy this template:**
```markdown
---
name: my-new-skill
description: One line description of what this does.
name: my-awesome-skill
description: "Brief one-line description of what this skill does"
---
# My New Skill
# Skill Title
## Overview
What problem does this solve?
Explain what this skill does and when to use it.
## Usage Examples
## When to Use This Skill
> "@my-new-skill help me..."
- Use when [scenario 1]
- Use when [scenario 2]
## Core Instructions
## How It Works
[Detailed instructions for the AI]
Detailed step-by-step instructions for the AI...
## Examples
### Example 1
\`\`\`
code example here
\`\`\`
## Best Practices
- ✅ Do this
- ❌ Don't do this
```
### Step 4: Validate (CRITICAL)
#### Step 4: Validate (CRITICAL V3 STEP)
Run the validation script locally. **We will not merge PRs that fail this check.**
@@ -96,33 +124,113 @@ python3 scripts/validate_skills.py
python3 scripts/validate_skills.py --strict
```
### Step 5: Test & Submit
This checks:
1. Copy it to your local agent folder (`.agent/skills/`).
2. Test it with your AI.
3. Push and open a Pull Request!
- ✅ `SKILL.md` exists
- ✅ Frontmatter is correct
- ✅ Name matches folder name
- ✅ Quality Bar checks passed
#### Step 5: Submit Your Skill
```bash
git add skills/my-awesome-skill/
git commit -m "feat: add my-awesome-skill"
git push origin my-branch
```
---
## 💡 Best Practices for V3
## Skill Template (Copy & Paste)
- **Be Specific**: Don't say "Write code". Say "Write strict TypeScript code using these patterns...".
- **Use Examples**: The AI learns best from examples.
- **Keep it Atomic**: One skill, one job. Don't make "god skills".
Save time! Copy this template:
```markdown
---
name: your-skill-name
description: "One sentence describing what this skill does and when to use it"
---
# Your Skill Name
## Overview
[2-3 sentences explaining what this skill does]
## When to Use This Skill
- Use when you need to [scenario 1]
- Use when you want to [scenario 2]
## Step-by-Step Guide
### 1. [First Step Name]
[Detailed instructions]
## Examples
### Example 1: [Use Case Name]
\`\`\`language
// Example code here
\`\`\`
## Best Practices
- ✅ **Do:** [Good practice]
- ❌ **Don't:** [What to avoid]
## Troubleshooting
**Problem:** [Common Issue]
**Solution:** [How to fix it]
```
---
## ⚖️ Code of Conduct
## Commit Message Guidelines
We adhere to the [Contributor Covenant](https://www.contributor-covenant.org).
**Rule #1**: Be kind.
**Rule #2**: No malware/harmful skills. (See `docs/SECURITY_GUARDRAILS.md`).
Use these prefixes:
- `feat:` - New skill or major feature
- `docs:` - Documentation improvements
- `fix:` - Bug fixes
- `refactor:` - Code improvements without changing functionality
- `test:` - Adding or updating tests
- `chore:` - Maintenance tasks
**Examples:**
```
feat: add kubernetes-deployment skill
docs: improve getting started guide
fix: correct typo in stripe-integration skill
```
---
## 📦 Submission Checklist
## Learning Resources
- [ ] Folder name is `kebab-case`
- [ ] `SKILL.md` exists
- [ ] `scripts/validate_skills.py` passes
- [ ] You tested it in an actual AI session
### New to Git/GitHub?
- [GitHub's Hello World Guide](https://guides.github.com/activities/hello-world/)
- [Git Basics](https://git-scm.com/book/en/v2/Getting-Started-Git-Basics)
### New to Markdown?
- [Markdown Guide](https://www.markdownguide.org/basic-syntax/)
---
## Code of Conduct
- Be respectful and inclusive
- Welcome newcomers
- Focus on constructive feedback
- **No harmful content**: See `docs/SECURITY_GUARDRAILS.md`.
---
**Thank you for making this project better for everyone!**
Every contribution, no matter how small, makes a difference. Whether you fix a typo, improve a sentence, or create a whole new skill - you're helping thousands of developers!