Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (24 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 1.21 KB
Raw

Contributing to do-code

Thanks for helping improve do-code.

For the local stable/source dual-command workflow, see docs/local-development.md.

Before opening a pull request

  1. Open an issue first for large features or changes to the agent policy.

  2. Keep each pull request focused and include tests for behaviour changes.

  3. Do not add API keys, user conversations, local artifacts, or other sensitive data.

  4. Run the required checks locally:

    npm test
npm run typecheck
npm run build

Development conventions

  • TypeScript is used across the CLI, server, and web application.
  • Preserve user-owned worktree changes; agent and evaluator operations must be explicit and reversible where possible.
  • New provider integrations must keep credentials in local configuration or environment variables, never in source code, traces, or tests.
  • Changes to agent behaviour should add a regression case under test/.

Reporting bugs

For product bugs, use the GitHub bug report template and include the do-code error ID when one is available:

do-code errors show <error-id>

Do not report security vulnerabilities in public issues; see SECURITY.md.