Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (59 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

76 lines (59 loc) · 2.64 KB

Contributing to commit-echo

Getting Started

  1. Fork and clone the repository.
  2. Install dependencies: 
    npm install
  3. Build the project: 
    npm run build
  4. Run a smoke test: 
    node dist/index.js --help

Development Workflow

  • TypeScript source lives in src/.
  • Run npm run build to compile – no separate dev server needed.
  • Before opening a PR, ensure the project builds cleanly.

Project Structure

src/
├── index.ts          # CLI entry point (Commander)
├── types.ts          # Shared types
├── commands/         # Command implementations (init, suggest, history)
├── config/           # Config persistence
├── git/              # Git operations (diff)
├── history/          # History JSONL + style learner
├── llm/              # Prompt builder + API client
└── providers/        # LLM provider adapters

Code Conventions

  • Style: Minimal, no comments unless necessary. Match the existing code style.
  • Imports: Use ESM import syntax ("type": "module").
  • Formatting: Prettier is configured via .prettierrc. Run npm run format to auto-format the supported source files, or npm run format:check to verify formatting in CI.
  • No linter is configured – review your own diffs carefully.

Pull Request Process

  1. Create a feature branch from main.
  2. Make your changes and verify npm run build succeeds.
  3. Keep PRs focused – one feature or fix per PR.
  4. Write a clear, concise PR description explaining what and why.

Issue Templates

When opening an issue, use the closest template from .github/ISSUE_TEMPLATE/:

  • Bug report for reproducible defects
  • Feature request for product or workflow improvements
  • Good first issue for small, newcomer-friendly tasks with clear acceptance criteria

Adding a New LLM Provider

  1. Create a file in src/providers/ implementing the provider interface from src/types.ts.
  2. Add a new entry to the BUILTIN_PROVIDERS array in src/providers/registry.ts with the following fields:
    • key: Unique identifier (e.g., my-provider)
    • name: Display name (e.g., My Provider)
    • baseUrl: API base URL
    • apiKeyEnv: Environment variable name for the API key (e.g., MY_PROVIDER_API_KEY)
    • website: Provider website URL
    • docsUrl: Provider documentation URL
    • needsApiKey: true if an API key is required, false for local providers like Ollama
  3. Add any needed configuration keys in src/config/.

License

By contributing, you agree that your contributions will be licensed under the MIT License.