State the documentation and commit language - #149
Merged
Conversation
Documentation was already English throughout - CLAUDE.md, README.md, CHANGES.md, CONTRIBUTING.md and every XML doc comment carry no Cyrillic at all - but nothing said so, which leaves it to be inferred from the surroundings. A convention that is only ever inferred erodes at the first entry written in a hurry. Commit history is the case in point: 36 of the 562 subjects on dev are Russian. This repository is public and publishes to nuget.org, so its history is part of what a reader sees. Nothing is being rewritten - the existing subjects stay - but no more are to be added. Both lines go first in Development Notes: they govern everything else written there rather than sitting alongside it.
Merged
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.
Two lines in
CLAUDE.md→Development Notes.Documentation already follows this
Checked rather than assumed:
CLAUDE.md,README.md,CHANGES.mdandCONTRIBUTING.mdcontain no Cyrillic at all, and neither does any XML doc comment underXrpl/orBase/. The line records a convention that already holds — and a convention that is only ever inferred from its surroundings erodes at the first entry written in a hurry.Commit history does not
36 of the 562 subjects on
devare Russian. This repository is public and publishes to nuget.org, so its history is part of what a reader of the package sees.Nothing is being rewritten. Those 36 stay: rewriting 562 commits would break every SHA referenced from issues, pull requests and
CHANGES.md, and cosmetics do not buy that. The rule looks forward, and says so — no more are to be added.Placement
Both lines go first in
Development Notes. They govern everything else written there rather than sitting alongside it, and a reader deciding what language to write in should not have to reach the bottom of a list about.editorconfigand package management to find out.Scope
Documentation and commit messages. Issue and pull request text follows the same reasoning — it is equally public — but that is not what these lines claim, and stating more than was decided is its own kind of error.