docs: Standardize via CONTRIBUTING.md + WRITING.md - #1086
Merged
Conversation
why: AGENTS.md is read on every task, so a policy that matters to one
class of change costs context on all the others. Splitting how we work
from how we write lets each be loaded when it applies, and keeps both
discoverable to humans rather than only to agents.
what:
- Replace the AGENTS.md body with a router: the project map, universal
change discipline, then one pointer per class of change
- Add .github/WRITING.md for prose policy: voice, README, the CLI
(exit statuses, stdout/stderr, machine output, destructive-op
invariants), workspace-file conventions, doctests, MyST roles, the
changelog, docstrings, source comments, commits, and slop prevention
- Add .github/CONTRIBUTING.md for workflow policy: setup, the gates,
imports/typing, tests and fixtures, docs build, releasing, PRs,
decorum, and security, using the repo's real commands throughout
- Add src/tmuxp/AGENTS.md (with a CLAUDE.md symlink) for logging
standards and CLI color semantics, scoped to the package
- Turn docs/project/contributing.md and code-style.md into pointer
pages at the canonical .github files (a MyST {include} across the
docs/ boundary emits dead anchors on this Sphinx setup), keeping
every existing (label)= anchor
- Rewrite README.md: console/$ code blocks, one command per block, and
correct the developmental-release install examples to the
--prerelease allow form CHANGES already documents
- Delete docs/AGENTS.md, docs/CLAUDE.md, and the lowercase
.github/contributing.md, now superseded
- Exclude the nested AGENTS.md and its CLAUDE.md symlink from the wheel;
hatchling packages every file under the package directory, so contributor
guidance would otherwise ship inside every install
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1086 +/- ##
=======================================
Coverage 82.55% 82.55%
=======================================
Files 31 31
Lines 2768 2768
Branches 518 518
=======================================
Hits 2285 2285
Misses 346 346
Partials 137 137 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
tony
changed the title
CONTRIBUTING.md + WRITING.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
AGENTS.mdis read on every task, so a policy that matters to one class of change costs context on all the others. This splits how the project works from how it writes, so each loads when it applies, and makes both discoverable to humans rather than only to agents.The root file becomes a router. It carries what should always be visible — what the repository is, where things live, and the change discipline every diff is held to — then points at one document per class of change.
Layout
What moved
Nothing was deleted without a destination. Environment, commands, gates, testing strategy and fixtures moved to
.github/CONTRIBUTING.md. Docstring conventions, doctest rules, changelog conventions, code-block rules, the comment gates and slop prevention moved to.github/WRITING.md, along with the whole ofdocs/AGENTS.md("Documentation voice"), which is prose policy and now has one home.Verification
Every gate was run, and the doctest collection count was recorded before and after. Documented examples are executed by
pytest, so a preserved example that stopped being collected would be an invisible test deletion — the count is the proof it did not happen.This repository
AGENTS.mdgoes from 719 lines to 66, across 11 changed files. The only non-documentation change is apyproject.tomlwheel exclude: hatchling packages every file under the package directory, so the new nestedAGENTS.mdwould otherwise ship inside every install. The built wheel is byte-identical to trunk's apart from that file's absence.