Skip to content

chore: prepare for public release#27

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

chore: prepare for public release#27
AbirAbbas merged 4 commits into
mainfrom
chore/public-release-prep

Conversation

@AbirAbbas
Copy link
Copy Markdown
Contributor

Summary

Prepare pr-af for public open-source release. Matches the format of the already-public sibling repos (SWE-AF, agentfield).

  • Governance files — LICENSE (Apache 2.0), CODE_OF_CONDUCT, SECURITY, CONTRIBUTING, CHANGELOG, CODEOWNERS.
  • Makefile — test/lint/check/clean targets, mirroring SWE-AF's pattern.
  • .dockerignore — was tied to a placeholder template; replaced with pr-af-specific excludes that keep the build context tight without hiding the README.md hatchling needs at install time.
  • Stopped tracking the two committed .DS_Store files (root + benchmark/) and broadened .gitignore to cover the usual suspects (test/lint caches, editor metadata, env-var dotfiles).
  • README expanded — added an Installation section (docker + from-source), a Configuration section with the canonical env-var table, a Troubleshooting section covering the common failure modes (opencode install, budget caps, agent registration, GitHub rate limits, repo cloning), and Contributing / License footers. The existing pitch, architecture diagram, comparison table, and GitHub Actions example are preserved — this is additive, not a rewrite.

Test plan

  • CI green (ruff + Docker build)
  • Verified locally: 25 unit tests pass. One pre-existing tests/test_cost_tracker.py::TestCostTracker::test_async_log_success failure was already broken on origin/main and is unrelated to this PR.
  • Eyeball the rendered README on the PR page.
  • Eyeball the rendered LICENSE / CODE_OF_CONDUCT / SECURITY / CONTRIBUTING / CHANGELOG / CODEOWNERS.

🤖 Generated with Claude Code

AbirAbbas and others added 4 commits May 8, 2026 13:20
LICENSE (Apache 2.0), CODE_OF_CONDUCT, SECURITY, CONTRIBUTING, CHANGELOG,
and CODEOWNERS — matching the format used by the sibling AgentField repos.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Makefile mirrors SWE-AF's pattern: test, lint, check, clean targets
for a consistent dev experience across the AgentField repos.

.dockerignore was previously tied to a placeholder template (referenced
swe_af.egg-info) — replaced with pr-af-specific excludes that keep the
Docker build context tight without hiding the README.md hatchling needs
at install time.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The repo had two committed .DS_Store files (root and benchmark/) and a
thin .gitignore that didn't catch them. Untrack the existing two and
expand .gitignore to cover the usual suspects (test/lint caches,
editor metadata, env-var dotfiles) so they don't reappear.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Add an installation section with both the docker-compose path and a
from-source path; a Configuration section with the canonical env-var
table (matching .env.example); a Troubleshooting section covering the
common failure modes (opencode install, budget caps, agent registration,
GitHub rate limits, repo cloning); and Contributing / License footers.

The existing pitch, architecture diagram, comparison table, and GitHub
Actions example are preserved — this is additive, not a rewrite.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@AbirAbbas AbirAbbas merged commit 0bd5845 into main May 8, 2026
2 checks passed
@AbirAbbas AbirAbbas deleted the chore/public-release-prep branch May 8, 2026 17:35
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