Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (27 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

46 lines (27 loc) · 1.53 KB

Contributing to kane-cli

Thank you for your interest in contributing to kane-cli! We welcome contributions to documentation and skills.

What You Can Contribute

Documentation

Improvements to README, guides, and other docs — typo fixes, clarifications, better examples.

Skills

The kane-cli skill teaches AI agents how to use the CLI effectively. Skill files live in:

  • .claude/skills/kane-cli/SKILL.md — Claude Code
  • .agents/skills/kane-cli/SKILL.md — Codex CLI
  • skill-installer/skills/SKILL.md — npm skill package

Skill contributions include: improving instructions, adding examples, covering new commands, fixing inaccuracies.

Note: Keep all three skill files in sync when making changes.

How to Contribute

  1. Fork the repository
  2. Create a branch from main (git checkout -b my-change)
  3. Make your changes — keep commits focused and descriptive
  4. Open a Pull Request against main

Guidelines

  • Keep changes focused — one PR per topic
  • Follow the existing style and formatting
  • Test that Markdown renders correctly before submitting

Reporting Bugs & Requesting Features

Use GitHub Issues to report bugs or request features. Both humans and AI agents are welcome to file issues.

Code of Conduct

All participants are expected to follow our Code of Conduct.

Questions?

Open a blank issue and we'll point you in the right direction.