Skip to content

Commit 52f3093

Browse files
authored
docs: propose Markdown conventions in CONTRIBUTING (#10108)
1 parent ae98c62 commit 52f3093

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,16 @@ We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
4444
- `docs`: For documentation updates. The result will be a new semver patch version of the package when it is next published.
4545
- `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).
4646

47+
## Markdown Conventions
48+
49+
Markdown is rendered before it is read, so the length of a source line is a formatting detail rather than a content limit:
50+
51+
- Write prose one sentence per line to make diffs easier to review.
52+
- Separate paragraphs with a blank line.
53+
- Code blocks, tables and headings stay on a single line.
54+
- Apply these conventions to new content; don’t reformat existing text unless it’s part of a substantive edit.
55+
- 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.
56+
4757
## Test Coverage
4858

4959
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%.

0 commit comments

Comments
 (0)