New rules
DOC-EN
DOC-EN19
Explain acronyms and abbreviations on first use. However, don't do this for common terms used in everyday life.
- "POC" is "point-of-contact (POC)" on first use, then use "POC" after
- Common terms like Graphics Interchange Format (GIF) should just be GIF
Miscellaneous changes
New contribution guidelines
The contribution guidelines have been updated to include the following new sections:
Requirements for proposing new rules
- A description of the new rule in one or two sentences
- An explanation of what issue it'll fix
- Examples of writing before and after the rule is applied
- If possible, some example of where this rule fixed the issue described above
- Good examples include techniques from the W3C, or examples from well-known style guides
- Bad examples include personal opinions or anecdotal evidence
A new issue template has been created to include these new requirements.
Requirements for pull requests
- Update the documentation as needed
- Reference the issue your pull request fixes
- All pull requests should be linked to an issue, even if it's just a minor fix. This makes separating general discussion from development easier.
- (Maintainers only) All pull requests should have a branch name that reflects the issue type, number, and a short description. For example,
feature/123-new-rule-descriptionorbug/456-fix-typo.
Full changelog: 2025.09.07...2025.10.05