Skip to content

Document how to add a custom provider in README #238

Description

@404-Page-Found

Description

The AGENTS.md documents the provider system (create src/providers/my-provider.ts, add to BUILTIN_PROVIDERS, wire into createProvider()), but the user-facing README does not explain how to add a new provider or use the custom provider entry.

Problem Statement

Users who want to point commit-echo at a non-builtin OpenAI-compatible endpoint have no clear documentation, leading to confusion around the __custom__ provider key and CUSTOM_API_KEY env var.

Proposed Solution

Add a "Custom Providers" section to the README covering:

  • How to use the custom provider key
  • Setting COMMIT_ECHO_BASE_URL / CUSTOM_API_KEY
  • How to contribute a new builtin provider

Additional Context

Relevant constants: CUSTOM_PROVIDER_KEY and CUSTOM_API_KEY_ENV in src/providers/registry.ts:3-4.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation updatesdocumentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    Fields

    No fields configured for Task.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions