Skip to content

Commit cc9c89d

Browse files
committed
docs: document PyPI release workflow and add CLAUDE.md pointer
- AGENTS.md: add Releasing section so contributors know to run `make release` (patch / minor / major) after merging a PR with user-visible changes. Picks the bump from semver and references the publish.yml workflow that takes over from the tag push. - CLAUDE.md: stub that points to AGENTS.md so Claude Code finds the canonical contributor docs (AGENTS.md is the cross-tool convention).
1 parent d7eec33 commit cc9c89d

2 files changed

Lines changed: 24 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,21 @@ Update both files:
2222
| `eval_mcp/provider_pricing.json` | Source of truth for model pricing |
2323
| `eval_mcp/core/judge_config.py` | Default judge models and criteria |
2424
| `Makefile` | Local dev commands (`make dev`, `make run`, `make stop`) |
25+
26+
## Releasing
27+
28+
After merging a PR with user-visible changes, publish to PyPI from main:
29+
30+
```bash
31+
git checkout main && git pull
32+
make release # patch bump (0.3.0 → 0.3.1) — bug fixes only
33+
make release-minor # minor bump (0.3.0 → 0.4.0) — new features, backwards-compat
34+
make release-major # major bump (0.3.0 → 1.0.0) — breaking changes
35+
```
36+
37+
Each target bumps `pyproject.toml`, commits, tags `vX.Y.Z`, and pushes.
38+
The `publish.yml` GitHub workflow takes over from the tag push and
39+
publishes to PyPI via trusted publisher. Don't tag manually.
40+
41+
Pick the bump from semver: new public API = minor, only bug fixes =
42+
patch, backwards-incompatible = major.

CLAUDE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# CLAUDE.md
2+
3+
Contributor and agent-facing instructions for this repo live in
4+
[AGENTS.md](./AGENTS.md). That file is the canonical source — read it
5+
first. Same convention is used by Codex, Cursor, and other agentic
6+
tools, so we keep a single file rather than splitting per-tool docs.

0 commit comments

Comments
 (0)