Skip to content

Commit fcf7696

Browse files
ChALkeRjasnell
authored andcommitted
doc: enable first-heading-level remark-lint rule
This makes sure that the first heading in all markdown files is h1. Only three files needed to be changed to conform: 1. BUILDING.md 2. CODE_OF_CONDUCT.md 3. doc/onboarding-extras.md Also, .remarkrc is updated to include the `first-heading-level: 1` rule in order to catch similar issues in the future. PR-URL: nodejs#8716 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent e5f5f3a commit fcf7696

File tree

4 files changed

+9
-7
lines changed

4 files changed

+9
-7
lines changed

.remarkrc

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"file-extension": "md",
1414
"final-definition": true,
1515
"final-newline": true,
16-
"first-heading-level": false,
16+
"first-heading-level": 1,
1717
"hard-break-spaces": true,
1818
"heading-increment": false,
1919
"heading-style": "atx",

BUILDING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Building Node.js
1+
# Building Node.js
22

33
Depending on what platform or features you require, the build process may
44
differ slightly. After you've successfully built a binary, running the

CODE_OF_CONDUCT.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Code of Conduct
1+
# Code of Conduct
22

3-
### Conduct
3+
## Conduct
44

55
* We are committed to providing a friendly, safe and welcoming
66
environment for all, regardless of level of experience, gender
@@ -38,17 +38,17 @@
3838
documentation. There is no need to address persons when explaining
3939
code (e.g. "When the developer").
4040

41-
### Contact
41+
## Contact
4242
Instances of abusive, harassing, or otherwise unacceptable behavior may be
4343
reported by:
4444

4545
* Emailing [[email protected]](mailto:[email protected]) (this will email all TSC members)
4646
* Contacting [individual TSC members](https://nodejs.org/en/foundation/tsc/#current-members-of-the-technical-steering-committee).
4747

48-
### Moderation
48+
## Moderation
4949
See the TSC's [moderation policy](https://github.com/nodejs/TSC/blob/master/Moderation-Policy.md) for details about moderation.
5050

51-
### Attribution
51+
## Attribution
5252

5353
This Code of Conduct is adapted from [Rust's wonderful
5454
CoC](http://www.rust-lang.org/conduct.html) as well as the

doc/onboarding-extras.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Additional Onboarding Information
2+
13
## Who to CC in issues
24

35
| subsystem | maintainers |

0 commit comments

Comments
 (0)