Skip to content

Contribute

Courier is pre-1.0 and welcomes focused bug reports, documentation fixes, design feedback, and pull requests.

Our goal is to keep the issue tracker and documentation structured, searchable, and useful to future contributors. Pick the contribution path that matches what you are trying to do, then include the information maintainers need to review it efficiently.

Create an issue

  •   Something is not working?

    Report a bug with a small reproduction, the Courier commit you are running, and relevant logs.

    Report a bug

  •   Missing information in the docs?

    Report missing information, incorrect examples, stale links, or unclear explanations.

    Report a docs issue

  •   Want to submit an idea?

    Propose a behavior change, new component API, or configuration improvement.

    Request a change

Contribute

  •   Want to contribute to the code?

    Open a focused pull request after discussing larger changes and running the local checks.

    Make a pull request

  •   Need the local workflow?

    Set up the Rust project, run tests, preview docs, and learn the project layout.

    Development

Checklist

Before interacting with the project, make sure the issue or pull request is specific, actionable, and easy to review.

Issues and comments are permanent

Everything you write in issues and pull requests remains visible to future readers. Keep it constructive, concise, and aligned with the code of conduct.

Before creating an issue

  • Are you using the right issue type: bug report, documentation issue, or change request?
  • Have you searched for an existing issue or pull request that covers the same topic?
  • Did you include the config, command, logs, links, or use case needed to understand the request?

Before commenting

  • Is your comment directly related to the current issue?
  • Does it add new information, a reproduction, a workaround, or a clearer explanation?
  • Would a reaction be enough instead of another comment?

Incomplete contributions

Maintainers may close issues that do not include enough information to reproduce, evaluate, or act on the request. They can be reopened when the missing information is provided.

Common reasons an issue may be closed:

  • The report has no minimal configuration or relevant logs.
  • The request duplicates an existing issue.
  • The issue is a support question rather than a bug report or change request.
  • The report is generated output without an explanation of what is wrong and why it matters.
  • The issue or pull request appears to be AI-generated and was not reviewed, tested, or edited by the author.

AI tools are fine as drafting aids, but the submitted issue or pull request should be concise, accurate, and verified by the contributor.