diff --git a/.gitignore b/.gitignore index 496ee2ca..d410d06b 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,5 @@ -.DS_Store \ No newline at end of file +.DS_Store +node_modules/ +.env +.env.* +*.log diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..92efc50f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing to Agent Skills + +Thanks for your interest in contributing! This project is a collection of production-grade engineering skills for AI coding agents. + +## Adding a New Skill + +1. Create a directory under `skills/` with a kebab-case name +2. Add a `SKILL.md` following the format in [docs/skill-anatomy.md](docs/skill-anatomy.md) +3. Include YAML frontmatter with `name` and `description` fields +4. Ensure the `description` starts with "Use when" and describes triggering conditions + +### Skill Quality Bar + +Skills should be: + +- **Specific** — Actionable steps, not vague advice +- **Verifiable** — Clear exit criteria with evidence requirements +- **Battle-tested** — Based on real engineering workflows, not theoretical ideals +- **Minimal** — Only the content needed to guide the agent correctly + +### Structure + +Every skill should include these sections: + +- **Overview** — What this skill does and why it matters +- **When to Use** — Triggering conditions +- **Process** — Step-by-step workflow +- **Common Rationalizations** — Excuses agents use to skip steps, with rebuttals +- **Red Flags** — Warning signs that the skill is being applied incorrectly +- **Verification** — How to confirm the skill was applied correctly + +### What Not to Do + +- Don't duplicate content between skills — reference other skills instead +- Don't add skills that are vague advice instead of actionable processes +- Don't create supporting files unless content exceeds 100 lines +- Don't put reference material inside skill directories — use `references/` instead + +## Modifying Existing Skills + +- Keep changes focused and minimal +- Preserve the existing structure and tone +- Test that YAML frontmatter remains valid after edits + +## Reporting Issues + +Open an issue if you find: + +- A skill that gives incorrect or outdated guidance +- Missing coverage for a common engineering workflow +- Inconsistencies between skills + +## License + +By contributing, you agree that your contributions will be licensed under the MIT License. diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..d67778ad --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Addy Osmani + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/skills/idea-refine.zip b/skills/idea-refine.zip deleted file mode 100644 index cdaa194e..00000000 Binary files a/skills/idea-refine.zip and /dev/null differ