Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

23 lines (15 loc) · 2.3 KB

Contributing

First contribution

  • Share feedback. Check open issues for the same problem or proposal and add any new details there. For a new idea, explain what you were trying to do and what would make it easier.
  • Report a problem. Include a short reproduction and the relevant environment. For a UI issue, a sanitized screenshot and the browser version can help. Remove credentials, private URLs, and sensitive task data before posting.
  • Report a security issue. Do not open a public issue for a vulnerability; follow SECURITY.md to report it privately.
  • Send a small change. A documentation correction or a focused UI improvement is a good place to start. Check open pull requests for overlapping work and refer to the relevant issue in your PR so readers can find the discussion.

Pull requests

  • At most 7 open pull requests per contributor. The repository enforces this with GitHub's pull request creation limit, drafts included: when you reach it, close or merge one before opening another. Review is manual, one change at a time, so a larger batch makes the queue unmanageable and slows everyone down, including you. If you have more changes queued, open one issue that lists them and wait for the current ones to be reviewed.
  • One focused change per PR. If a change has independent parts, split it into a small number of PRs and say in each description what the other parts depend on.
  • Describe the change. State the problem, the behavior change and what you tested. A pull request with no description is a request for changes.
  • Provider support stays generic. Any OpenAI- or Anthropic-compatible endpoint works through a model profile; provider convenience goes in as a neutral preset (name and base URL) or a docs recipe, with no vendor logos, promotional codes, baked vendor endpoints, or vendor-specific environment variables. A new wire format needs a schema migration, a profile save/load test, and a live connection test.

Issues

  • One problem per issue. Include the version or commit, what you ran and what you expected.

Security