docs: pull request descriptions pass the plain-writing checker first - #19
Merged
Merged
Conversation
…ore it is written
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.
What
The pull request description is written only after it has passed the plain-writing checker with every finding fixed. The rule joins the four-heading structure in the completion chapter and in this repository's AGENTS.md.
Why
The owner ruled it on 2026-09-24: a description that has not passed the checker is not written. The same rule now sits in the global instruction files for Claude Code and Codex.
How
docs/help/completion-and-done.md: one paragraph under the pull request description section.AGENTS.md: the same rule under commits and releases.Tests
The two tests that cover the help chapters ran once and passed. This body was written to a file and passed the checker before it was used. CI runs the full suite.