Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (27 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.39 KB

Contributing

Thanks for considering a contribution. Here's how to do it well.

Reporting bugs

Open an issue using the Bug report template. Include:

  • What you expected to happen
  • What actually happened
  • The agent you're using (Claude Code, Cursor, OpenCode, etc.)
  • Any error messages or unexpected output

Suggesting improvements

Open an issue using the Feature request template. Describe the problem you're solving, not just the solution you want. Context helps.

Pull requests

  1. Fork the repo and create a branch from main
  2. Make your changes
  3. Make sure the SKILL.md still passes skillcheck validation
  4. Open a PR using the pull request template
  5. Describe what changed and why

What makes a good PR

  • One concern per PR. Don't bundle unrelated changes.
  • If you're modifying SKILL.md, keep it under 3,000 words. Move detailed content to references/.
  • If you're adding a reference file, make sure SKILL.md points to it in the Bundled Resources table.
  • Test with at least one real codebase before submitting.

Style

  • SKILL.md uses imperative form ("Run the command", not "You should run the command")
  • SKILL.md description uses third person ("This skill should be used when...")
  • README and human-facing docs: write like a person, not a press release

Code of conduct

Be direct, be helpful, don't waste people's time. That covers it.