Skip to content

Require natural English in explanatory prose - #25

Merged
id774 merged 1 commit into
masterfrom
policy/clarify-common-maintenance-rules
Nov 1, 2026
Merged

id774 merged 1 commit into
masterfrom
policy/clarify-common-maintenance-rules

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Purpose

This pull request writes the maintenance rule on natural English explanatory prose into doc/POLICY.md, which holds the maintenance policy of this repository. The rule is part of a set of common maintenance principles that is being added to each repository where the policy does not yet state it.

What changed

  • Added the rule on natural English explanatory prose as a paragraph at the end of section 1.12, Naming, Comments, and Language.

The new text is added once at each location. No existing rule, heading number, link, or example is removed, reworded, or renumbered.

Preserved behavior

This change touches only doc/POLICY.md. Source code, tests, the README, the requirements and design documents, configuration, dependencies, license files, and doc/VERSIONS are unchanged, so the behavior of the repository and its existing rules and exceptions remain as they were. Historical text is not rewritten to match the new rule.

Validation

  • Confirmed that the diff against master consists of one commit that adds lines to doc/POLICY.md and deletes none.
  • Confirmed that each added rule appears exactly once at its stated location and matches the agreed wording.
  • Confirmed that git diff --check reports no whitespace errors.

No runtime tests were run, because the change is limited to a policy document and does not affect any executable code.

Version History

No version number, release entry, or tag is changed, and doc/VERSIONS is not updated because this is a policy-only change.

@id774
id774 merged commit e9ee738 into master Nov 1, 2026
2 checks passed
@id774
id774 deleted the policy/clarify-common-maintenance-rules branch November 1, 2026 15:07
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