Skip to content

Require natural English in explanatory prose #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
id774 merged 1 commit into from
Nov 1, 2026
Merged

Require natural English in explanatory prose #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions doc/POLICY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,16 @@ A comment preserves a reason, constraint, non-obvious intent, or decision that a
later change could otherwise undo. Do not use comments merely to restate code
whose operation is already evident.

Write English explanatory prose in clear, natural sentences. Do not replace a
sentence with a label and a colon, a status prefix such as `Implement:` or
`Incompatible:`, a symbol, or an unexplained abbreviation. Apply this to
English prose in comments, docstrings, documentation, version histories,
release notes, commit messages, and pull request descriptions. This rule does
not alter the established forms of headings, list labels, tables, code,
configuration syntax, machine-readable fields, literal interface strings, or
non-English content required by the repository's purpose. Do not rewrite
historical entries or unrelated text merely to align their style.

### 1.13 Documentation

#### 1.13.1 Repository README
Expand Down
Loading