Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (31 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

47 lines (31 loc) · 1.11 KB
Raw

Contributing

Quick Start

  1. Fork the repo and clone it
  2. Create a feature branch (feature/add-toolname-skill)
  3. Make your changes, test them, submit a PR

Adding a Skill

Place skills in the following structure:

skills/
└── ToolName/              # PascalCase or exact tool name
    └── SKILL.md           # Skill documentation

Copy templates/SKILL.template.md into your new directory and fill it in. Each SKILL.md needs:

  • YAML frontmatter with a description field
  • Tool overview, command syntax, common options
  • Workflow examples with output field descriptions

Standards

  • Verify all commands and flags work before submitting
  • Follow the format of existing skills
  • Use PascalCase or exact tool name for tool directories

Pull Requests

  • Give your PR a clear title and description
  • Reference any related issues
  • Describe how you tested your changes

Reporting Issues

Open an issue with:

  • Tool name/version and OS
  • Steps to reproduce (for bugs)
  • Use case description (for feature requests)

License

Contributions are licensed under the Apache License 2.0.