Skip to content

chore: public-release follow-ups (issue templates, anchor fixes, model alignment)#28

Merged
AbirAbbas merged 4 commits into
mainfrom
chore/public-release-prep-2
May 8, 2026
Merged

chore: public-release follow-ups (issue templates, anchor fixes, model alignment)#28
AbirAbbas merged 4 commits into
mainfrom
chore/public-release-prep-2

Conversation

@AbirAbbas
Copy link
Copy Markdown
Contributor

Summary

Follow-up to #27 with fixes and polish surfaced in a fresh-eyes review.

  • Fix three broken README anchors at the top of the file. `#what-you-get-back` and `#comparison` pointed at sections that don't exist or have been renamed. Repoint to the actual section ids and add a Configuration link.
  • Document the GitHub App auth path in `.env.example`. `GITHUB_APP_ID` / `GITHUB_APP_PRIVATE_KEY` are fully wired in `src/pr_af/github/client.py` but were never documented in the example env file. Add them alongside `GH_TOKEN` with a note that App auth is preferred when both are present. Also plumb the same pair through `docker-compose.yml` so compose deploys can use App auth without editing the file.
  • Correct the CONTRIBUTING.md description of CI. Previously said "CI runs ruff and pytest on every push" — only ruff and the Docker build run in CI today. Spell out what CI actually does so contributors aren't surprised when CI passes despite local test failures.
  • Match Makefile lint scope to CI. CI runs `ruff check src/ scripts/` but the Makefile checked `src/ tests/`. Aligned to CI; `make lint` now passes.
  • Align deployment model defaults to `kimi-k2.6`. Code defaults (`src/pr_af/config.py`) and `.env.example` both name `openrouter/moonshotai/kimi-k2.6`, but the Dockerfile and docker-compose hard-coded `kimi-k2.5`. Docker users were silently getting k2.5 while the docs said k2.6.
  • Plumb budget knobs through docker-compose with a comment pointing out the default 300s / $2 budget is sized for smoke tests; real reviews need `PR_AF_NO_BUDGET=true` (or raised caps) to run to completion.
  • Add GitHub issue / PR templates — bug / feature / security forms matching SWE-AF's format.

Test plan

  • CI green (ruff + Docker build)
  • `make lint` passes locally
  • Eyeball the rendered README on the PR page — verify the nav links at the top jump to the right sections
  • Open a fresh issue — confirm the bug-report form renders correctly
  • Optional: a smoke deploy via docker-compose to confirm `HARNESS_MODEL=kimi-k2.6` is actually picked up

🤖 Generated with Claude Code

AbirAbbas and others added 4 commits May 8, 2026 13:56
- Three nav anchors at the top of the README pointed at sections that
  don't exist or have been renamed (#what-you-get-back, #comparison).
  Repoint to the actual section ids and add a Configuration link.
- The GitHub App auth path (GITHUB_APP_ID / GITHUB_APP_PRIVATE_KEY) is
  fully wired in src/pr_af/github/client.py but wasn't documented in
  .env.example. Add it alongside GH_TOKEN with a note that App auth is
  preferred when both are present.
- CONTRIBUTING.md claimed "CI runs ruff and pytest on every push" — only
  ruff and the Docker build run in CI today. Correct the description so
  contributors aren't surprised when CI passes despite local test
  failures.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
CI runs `ruff check src/ scripts/` but the Makefile checked `src/ tests/`.
Result: contributors running `make lint` locally would miss the
scripts/ issues that CI catches, and the unused-import noise in
tests/ that CI ignores would fail their local lint without ever
blocking a PR. Align the Makefile to CI.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Code defaults (src/pr_af/config.py) and .env.example both name
  openrouter/moonshotai/kimi-k2.6, but the Dockerfile and docker-compose
  hard-coded kimi-k2.5 in their env blocks. Result: docker users got
  k2.5 silently while the README documented k2.6. Bump both to k2.6.
- Add the GitHub App auth env pair (GITHUB_APP_ID, GITHUB_APP_PRIVATE_KEY)
  to docker-compose so the App-auth path actually works in compose
  deploys; previously only GH_TOKEN / GITHUB_TOKEN were forwarded.
- Add the budget knobs (PR_AF_NO_BUDGET, PR_AF_MAX_DURATION_SECONDS,
  PR_AF_MAX_COST_USD, PR_AF_MAX_CONCURRENT_REVIEWERS) with a comment
  pointing out that the default 300s / $2 budget is sized for smoke
  tests and a real review needs PR_AF_NO_BUDGET=true (or raised caps)
  to run to completion.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Three issue forms (bug, feature, security-via-config) and a PR template
matching the format used in SWE-AF. Public-facing repos benefit from
the structured templates — bug reports without reproduction steps and
PRs without a validation checklist are the two most common things that
slow review.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@AbirAbbas AbirAbbas merged commit 7a78ed9 into main May 8, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant