Thanks for your interest in improving OpenAgentPack. By participating you agree to our Code of Conduct.
| 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 |
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 togetherbun 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.
Every PR must satisfy:
bun run verify:full- At least one maintainer approval
- No unresolved review comments
We keep the contribution path open: documentation, examples, and ordinary small changes do not need a design document or a special PR label. Changes to provider contracts, configuration/schema parsing, release/package files, or GitHub workflows 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.
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.
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.