Skip to content

Repo polish: license, CI, community health files, README#15

Merged
PhungVanDuy merged 5 commits into
mainfrom
chore/github-polish
Jul 2, 2026
Merged

Repo polish: license, CI, community health files, README#15
PhungVanDuy merged 5 commits into
mainfrom
chore/github-polish

Conversation

@PhungVanDuy

Copy link
Copy Markdown
Contributor

Summary

Gets the repo into shape for external review. Before this PR, GitHub showed no license, no CI, no contributing/security policies, and the README had a few rough edges.

  • License: Apache-2.0 at the root for the code (the technical report stays CC BY 4.0, matching CITATION.cff). pyproject.toml gains license, authors, keywords, classifiers, and project URLs; uv build verified.
  • CI: GitHub Actions workflow running ruff, mypy, and pytest on Python 3.11/3.12/3.13. All three pass locally (199 passed, 7 skipped smoke tests).
  • Fixes: one stale test assertion left over from the Quick (Copy this) Agentic Instructions to install and use Zenith as a /zenith skill  #5 wording change, a grammar fix in the zenith init next-steps message, and an unused import flagged by ruff.
  • Hygiene: removed committed LaTeX build artifacts (.aux/.out/.toc/.listing), added a root .gitignore.
  • README: badges (CI, license, Python, report PDF), a one-paragraph overview, restructured quick start, source attribution for the Frontier SWE table (the ¹/² footnote markers had no definitions), repository layout, and a license section. Typos fixed in the agent-install prompt (hernesses, Infact).
  • Community health: CONTRIBUTING.md, SECURITY.md (GitHub private vulnerability reporting), issue templates, PR template.

Checklist

  • uv run ruff check . passes
  • uv run mypy src passes
  • uv run pytest -q passes (199 passed, 7 skipped)

🤖 Generated with Claude Code

Duy Phung and others added 5 commits July 2, 2026 16:05
Add the Apache License 2.0 at the repo root (code license; the technical
report remains CC BY 4.0 per CITATION.cff) and fill in pyproject metadata:
license, authors, keywords, classifiers, and project URLs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The codex init test still asserted the pre-#5 next-steps wording. Align the
CLI message grammar with the README phrasing and update the assertion.
Drop an unused Task import flagged by ruff.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
README: add CI/license/python/report badges, a one-paragraph overview,
cleaner quick-start (agentic + manual), source attribution for the
Frontier SWE table (the footnote markers had no definitions), repository
layout, contributing pointers, and a license section. Fix typos in the
agent-install prompt. Add CONTRIBUTING.md, SECURITY.md, and issue/PR
templates.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@PhungVanDuy PhungVanDuy merged commit 73f0004 into main Jul 2, 2026
3 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