Skip to content

docs: propose Markdown conventions in CONTRIBUTING #10108

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
nkolev92 merged 2 commits into from
Oct 23, 2026
+10 −0
Merged

docs: propose Markdown conventions in CONTRIBUTING #10108

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a54b544
docs: document Markdown conventions in CONTRIBUTING
ump45nose Oct 4, 2026
3846fae
docs: address Markdown convention review feedback
ump45nose Oct 21, 2026
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 CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,16 @@ We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
- `docs`: For documentation updates. The result will be a new semver patch version of the package when it is next published.
- `chore`: For changes that do not affect the published module. Often these are changes to tests. The result will be *no* change to the version of the package when it is next published (as the commit does not affect the published version).

## Markdown Conventions

Markdown is rendered before it is read, so the length of a source line is a formatting detail rather than a content limit:

- Write prose one sentence per line to make diffs easier to review.
- Separate paragraphs with a blank line.
- Code blocks, tables and headings stay on a single line.
- Apply these conventions to new content; don’t reformat existing text unless it’s part of a substantive edit.
- Files generated by tooling (for example `CODE_OF_CONDUCT.md`, which is marked "do not edit", and the Artistic License text in `LICENSE`) are wrapped at 80 columns by whatever generated them. Leave generated wrapping as it is, and do not rewrap those paragraphs in unrelated pull requests.

## Test Coverage

We use [`tap`](https://node-tap.org/) for testing & expect that every new feature or bug fix comes with corresponding tests that validate the solutions. Tap also reports on code coverage and it will fail if that drops below 100%.
Expand Down
Loading