Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (32 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 1.76 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

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.