Skip to content

Repo tuning: contributor-agent docs, CoC, templates, coverage floor - #16

Merged
carlok merged 1 commit into
mainfrom
cursor/repo-tuning-contributor-docs-afba
Nov 13, 2026
Merged

carlok merged 1 commit into
mainfrom
cursor/repo-tuning-contributor-docs-afba

Conversation

@carlok

@carlok carlok commented Nov 13, 2026

Copy link
Copy Markdown
Owner

Verified gaps (before changes)

  • AGENTS.md — API pitfall guide only; no setup/tests/coverage/commit guidance for repo contributors.
  • CODE_OF_CONDUCT.md — missing.
  • .github/ISSUE_TEMPLATE/ — missing (only workflows + dependabot).
  • .github/pull_request_template.md — missing.
  • License left Apache-2.0 unchanged.

Changes

Item What
AGENT.md (new) Contributor guidance for coding agents: setup, python -m unittest discover -s tests, tests/coverage_report.py, raise coverage before commits, no secrets/host-specific values, keep public docs general.
AGENTS.md Two-line pointer at the top to AGENT.md so API guidance is unchanged.
Why AGENT.md vs a long AGENTS.md section AGENTS.md is linked from the README for using the solver API; mixing repo workflow into it would blur that purpose. A sibling file mirrors CONTRIBUTING.md vs product docs.
CODE_OF_CONDUCT.md Contributor Covenant 2.1; enforcement via @carlok on GitHub (no email).
.github/ISSUE_TEMPLATE/ bug_report.yml, feature_request.yml, config.yml (blank issues off; security link).
`.github/pull_request_template.md Checklist including coverage with --min 75.
Coverage floor Raised 72 → 75 in tests/coverage_report.py and CI (measured 76.9% total statement coverage on this branch).
CONTRIBUTING.md / README Floor note and short Contributing section with links to AGENT.md and CoC.

No product-code refactors.

Commands run locally

pip install dratify
python3 -m unittest discover -s tests -v    # 446 tests, OK (54 skipped)
python3 tests/coverage_report.py              # TOTAL 77% line in table; message: 76.9% >= 72% floor (pre-change)
python3 tests/coverage_report.py --min 75   # c ok: 76.9% >= 75% floor
python3 -m unittest discover -s tests -q && python3 tests/coverage_report.py --min 75  # re-run after edits

Measured coverage: 2693/3502 executable statements → 76.9% (tests/coverage_report.py).

Open in Web Open in Cursor 

Separate AGENT.md from API-focused AGENTS.md; add Contributor Covenant
2.1, issue/PR templates, and raise the statement-coverage floor to 75%
(measured ~76.9%).

Co-authored-by: Carlo Perassi <[email protected]>
@carlok
carlok merged commit 27e86f5 into main Nov 13, 2026
25 checks passed
@carlok
carlok deleted the cursor/repo-tuning-contributor-docs-afba branch November 13, 2026 21:14
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.

2 participants