Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (57 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

82 lines (57 loc) · 2.33 KB

Contributing to AI Dev OS CLI

Thank you for your interest in contributing!

How to Contribute

Reporting Issues

  • Use GitHub Issues
  • Specify which command is affected (init, update, or doctor)

Pull Requests

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run tests: npm test
  5. Run lint: npm run lint
  6. Commit with a descriptive message
  7. Open a Pull Request

What to Contribute

Directory What We Need Guidelines
src/commands/ Command improvements, new commands Follow Commander.js patterns. Keep each command focused on one task.
src/core/ Core logic improvements Pure functions preferred. No side effects in core modules except git/fs operations.
src/prompts/ Prompt UX improvements Use @inquirer/prompts. Keep prompts minimal and clear.
tests/ Test coverage improvements Use vitest. Test core modules thoroughly; commands via E2E tests.

Development Setup

# Install dependencies
npm install

# Build
npm run build

# Run tests
npm test

# Type check
npm run lint

# Local testing
node dist/index.js init --dry-run

Adding a New Command

  1. Create src/commands/{name}.ts
  2. Export a Command instance
  3. Register it in src/index.ts via program.addCommand()
  4. Add tests in tests/commands/{name}.test.ts

Adding a New Registry Entry

To add support for a new rules preset or plugin:

  1. Add the entry to src/core/registry.ts
  2. Include id, name, repo, and optional template/hooksFile/settingsDir
  3. No CLI version bump needed — just a patch release

Cross-Repository Considerations

When changing the CLI, consider impacts on:

Translation Guide

  • Translations are in docs/i18n/{lang}/
  • Currently supported: ja, zh-CN, ko, es

Code of Conduct

Be respectful, constructive, and inclusive.

Languages: English | 日本語