Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (34 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 2.79 KB
Raw

Contributing to OpenAgentPack

Thanks for your interest in improving OpenAgentPack. By participating you agree to our Code of Conduct.

Where to go

Topic Doc
Dev setup, verification, package boundaries docs/contributing/development.md
Adding a new provider docs/contributing/provider-development.md
npm release workflow English · 简体中文
Architecture and how it works docs/architecture/how-it-works.md

Quick start

git clone https://github.com/<your-github-user>/OpenAgentPack.git
cd OpenAgentPack
git remote add upstream https://github.com/modelstudioai/OpenAgentPack.git
bun install
bun run --cwd packages/cli bin/agents.ts --help   # run the CLI from source
bun run dev                                         # server + webui together

Verification

bun run verify:scoped  # fast feedback loop
bun run verify:full    # repository gate (required for merge)

CI runs the full profile in parallel. See Development for every profile.

Merge requirements

Every PR must satisfy:

  1. bun run verify:full
  2. At least one maintainer approval
  3. No unresolved review comments

We keep the contribution path open: documentation, examples, and ordinary small changes do not need a design document, a special PR label, or a commit-message marker. Changes to provider contracts, configuration/schema parsing, release/package files, GitHub workflows, or verification policy have a small additional requirement: fill in the Behavior / risk and Validation sections of the PR description. This lets maintainers review the contract and its evidence before reading an implementation diff without asking contributors to rewrite commit history. A generated bun.lock change by itself is handled by audit and compatibility checks.

Maintainers should enable the repository settings that make the same policy effective at merge time: require the Gate and Analyze TypeScript checks, require one approving review, dismiss stale approvals, require approval of the latest push, and require resolved conversations. CODEOWNERS review and a merge queue are intentionally not required for routine contributions at the current project stage.

Reporting bugs and requesting features

Open an issue using the templates under .github/ISSUE_TEMPLATE. For anything security-related, do not open a public issue — follow SECURITY.md instead.

For usage questions and design discussions, use GitHub Discussions.