Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (24 loc) · 935 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 935 Bytes

Contributing

Thanks for helping improve ZAI CLI and the skills marketplace.

Development setup

cd packages/zai-cli
npm install
npm run build
npm test

Project structure

  • packages/zai-cli contains the CLI package.
  • skills/ contains marketplace skills.

Adding a skill

  1. Create a new folder under skills/ using lowercase letters, numbers, and hyphens.
  2. Add a SKILL.md with YAML front matter (name, description) and concise instructions.
  3. Add any optional resources in references/, scripts/, or assets/.
  4. Update skills/README.md with the new skill.

See skills/zai-cli/SKILL.md for the full format.

Quality checks

  • Keep instructions concise and action-oriented.
  • Prefer data-only output formats for CLI examples.
  • Validate that all CLI examples work against the current version.

Reporting issues

Please use the issue templates in GitHub for bugs or feature requests.