From fcf7696bc1b64c61a6263d1f13f2af8501dbd207 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=A1=D0=BA=D0=BE=D0=B2=D0=BE=D1=80=D0=BE=D0=B4=D0=B0=20?= =?UTF-8?q?=D0=9D=D0=B8=D0=BA=D0=B8=D1=82=D0=B0=20=D0=90=D0=BD=D0=B4=D1=80?= =?UTF-8?q?=D0=B5=D0=B5=D0=B2=D0=B8=D1=87?= Date: Tue, 20 Sep 2016 07:54:35 +0300 Subject: [PATCH] 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: https://github.com/nodejs/node/pull/8716 Reviewed-By: James M Snell Reviewed-By: Luigi Pinca --- .remarkrc | 2 +- BUILDING.md | 2 +- CODE_OF_CONDUCT.md | 10 +++++----- doc/onboarding-extras.md | 2 ++ 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/.remarkrc b/.remarkrc index 143e9cdaaa..5244bd758c 100644 --- a/.remarkrc +++ b/.remarkrc @@ -13,7 +13,7 @@ "file-extension": "md", "final-definition": true, "final-newline": true, - "first-heading-level": false, + "first-heading-level": 1, "hard-break-spaces": true, "heading-increment": false, "heading-style": "atx", diff --git a/BUILDING.md b/BUILDING.md index 16663d60ac..3ffb2b51b2 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -1,4 +1,4 @@ -## Building Node.js +# Building Node.js Depending on what platform or features you require, the build process may differ slightly. After you've successfully built a binary, running the diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index c250585b81..4249ae1ca3 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,6 +1,6 @@ -## Code of Conduct +# Code of Conduct -### Conduct +## Conduct * We are committed to providing a friendly, safe and welcoming environment for all, regardless of level of experience, gender @@ -38,17 +38,17 @@ documentation. There is no need to address persons when explaining code (e.g. "When the developer"). -### Contact +## Contact Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by: * Emailing [report@nodejs.org](mailto:report@nodejs.org) (this will email all TSC members) * Contacting [individual TSC members](https://nodejs.org/en/foundation/tsc/#current-members-of-the-technical-steering-committee). -### Moderation +## Moderation See the TSC's [moderation policy](https://github.com/nodejs/TSC/blob/master/Moderation-Policy.md) for details about moderation. -### Attribution +## Attribution This Code of Conduct is adapted from [Rust's wonderful CoC](http://www.rust-lang.org/conduct.html) as well as the diff --git a/doc/onboarding-extras.md b/doc/onboarding-extras.md index 279bb38638..30bc3226bb 100644 --- a/doc/onboarding-extras.md +++ b/doc/onboarding-extras.md @@ -1,3 +1,5 @@ +# Additional Onboarding Information + ## Who to CC in issues | subsystem | maintainers |