Repository navigation
docs: propose Markdown conventions in CONTRIBUTING - #10108
Merged
Merged
Conversation
Contributors editing Markdown had no discoverable statement of what the house style actually is, so the same edits produced different results depending on who ran them. Prose in this repository is written one paragraph per line and is not hard wrapped, and one space follows a sentence period. Document both norms in CONTRIBUTING.md, the file contributors already read before opening a pull request. Also record that the 80-column wrapping in tool-generated files such as CODE_OF_CONDUCT.md comes from the generator, so it is left alone rather than "fixed". Closes: npm#5522
nkolev92
reviewed
Oct 21, 2026
Use one sentence per line and separate paragraphs with blank lines. Apply the conventions to new content without incidental reformatting. Prepared with AI assistance. Validated Markdown rendering and diff scope.
nkolev92
approved these changes
Oct 23, 2026
|
I see you have a few docs PRs, can you please update with these guidelines in mind. |
ump45nose
added a commit
to ump45nose/npm-cli
that referenced
this pull request
Oct 23, 2026
Apply the Markdown conventions from npm#10108 to this PR's new text only. Preserve wording, links, paragraph boundaries, and Markdown structure. Validation: rendered HTML equivalence (whitespace-normalized), text and scope assertions, and whitespace checks. Full npm/docs tests not run locally. AI-assisted formatting update.
ump45nose
added a commit
to ump45nose/npm-cli
that referenced
this pull request
Oct 23, 2026
Apply the Markdown conventions from npm#10108 to this PR's new text only. Preserve wording, links, paragraph boundaries, and Markdown structure. Validation: rendered HTML equivalence (whitespace-normalized), text and scope assertions, and whitespace checks. Full npm/docs tests not run locally. AI-assisted formatting update.
ump45nose
added a commit
to ump45nose/npm-cli
that referenced
this pull request
Oct 23, 2026
Apply the Markdown conventions from npm#10108 to this PR's new text only. Preserve wording, links, paragraph boundaries, and Markdown structure. Validation: rendered HTML equivalence (whitespace-normalized), text and scope assertions, and whitespace checks. Full npm/docs tests not run locally. AI-assisted formatting update.
ump45nose
added a commit
to ump45nose/npm-cli
that referenced
this pull request
Oct 23, 2026
Apply the Markdown conventions from npm#10108 to this PR's new text only. Preserve wording, links, paragraph boundaries, and Markdown structure. Validation: rendered HTML equivalence (whitespace-normalized), text and scope assertions, and whitespace checks. Full npm/docs tests not run locally. AI-assisted formatting update.
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
2 participants
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.
Adds a "Markdown Conventions" section to
CONTRIBUTING.md(no hard wrapping of prose, one space after a period, leave tool-generated files as generated).Status / please decide: #5522 asks whether these conventions should exist, and @lukekarrys commented that the team should reach consensus first. This PR proposes one answer (dropping the 80-column hard wrap for prose, as suggested in the issue) so there is something concrete to discuss; I have not changed any existing docs to match. Feel free to close if the team prefers a different convention. Refs #5522.
No tests run (docs only).
AI assistance disclosure: this change was prepared with the help of an AI coding agent (Grok Bot). The account owner has not reviewed every line in detail; please treat it accordingly.