Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (42 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

62 lines (42 loc) · 1.51 KB

Contributing to OAgent

Thanks for contributing.

Development setup

  1. Install Node.js 20+ and pnpm.
  2. Install dependencies:
pnpm install
  1. Start the app in development mode:
pnpm dev

Build and checks

Before opening a PR, run:

pnpm build
pnpm exec tsc --noEmit

Branch and commit conventions

  • Use focused branches (for example: codex/feature-name, fix/issue-123).
  • Keep commits small and atomic.
  • Write clear commit messages explaining intent.

Pull requests

  • Include a concise summary, rationale, and testing notes.
  • Link related issues.
  • Add screenshots/GIFs for UI changes.
  • Keep PR scope limited to one concern.
  • If you want public credit beyond commit history, add your preferred display name/link in the PR template so maintainers can feature you in CONTRIBUTORS.md.

Code style

  • Preserve existing patterns and naming unless a refactor is intentional.
  • Avoid unrelated formatting churn.
  • Prefer explicit, readable code over clever shortcuts.

Reporting bugs

Use the bug report template and include:

  • OS and version
  • Repro steps
  • Expected vs actual behavior
  • Logs and screenshots where possible

Recognition

  • First-time contributors can be added to CONTRIBUTORS.md after their first merged pull request.
  • Recent first-time contributors may also be featured in the Contributor Spotlight section.
  • If you want to be credited under a different public name than your GitHub handle, note that in your PR.