Skip to content

Commit 64f6a1c

Browse files
authored
docs: fix indentation to comply with CommonMark (#674)
Ref: #668 (comment)
1 parent a2db757 commit 64f6a1c

File tree

3 files changed

+27
-27
lines changed

3 files changed

+27
-27
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Writing good commit logs is important. A commit log should describe what
4040
changed and why. Follow these guidelines when writing one:
4141

4242
1. The first line should be a short description of the change
43-
(e.g. "get-metadata: check if the committer matches the author").
43+
(e.g. "get-metadata: check if the committer matches the author").
4444
2. Keep the second line blank.
4545
3. Wrap all lines at 72 columns.
4646

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ npm link
5555
Most of the tools need your GitHub credentials to work. You can either
5656

5757
1. Run any of the tools and you will be asked in a prompt to provide your
58-
username and password in order to create a personal access token.
58+
username and password in order to create a personal access token.
5959
2. Or, create a personal access token yourself on GitHub, then set them up
60-
using an editor.
60+
using an editor.
6161

6262

6363
If you prefer option 2, [follow these instructions](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)
@@ -97,18 +97,18 @@ To obtain the Jenkins API token
9797
\<your-github-username\> with your own GitHub username).
9898
2. Click on the `ADD NEW TOKEN` button in the `API Token` section.
9999
3. Enter an identifiable name (for example, `node-core-utils`) for this
100-
token in the inbox that appears, and click `GENERATE`.
100+
token in the inbox that appears, and click `GENERATE`.
101101
4. Copy the generated token.
102102
5. Add it into your `ncurc` file (`~/.ncurc` or `$XDG_CONFIG_HOME/ncurc`)
103-
with `jenkins_token` as key, like this:
103+
with `jenkins_token` as key, like this:
104104

105-
```json
106-
{
107-
"username": "your_github_username",
108-
"token": "your_github_token",
109-
"jenkins_token": "your_jenkins_token"
110-
}
111-
```
105+
```json
106+
{
107+
"username": "your_github_username",
108+
"token": "your_github_token",
109+
"jenkins_token": "your_jenkins_token"
110+
}
111+
```
112112

113113

114114
### Make sure your credentials won't be committed
@@ -136,8 +136,8 @@ If you encounter an error that you cannot fix by yourself, please
136136

137137
1. Make sure you update NCU to the latest version
138138
2. Try again with the `NCU_VERBOSITY=debug` environment variable set and
139-
open an issue at https://github.com/nodejs/node-core-utils/issues with
140-
detailed logs.
139+
open an issue at https://github.com/nodejs/node-core-utils/issues with
140+
detailed logs.
141141

142142
## Contributing
143143

docs/ncu-ci.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -106,24 +106,24 @@ Unstable https://ci.nodejs.org/job/node-test-commit-arm-fanned/15212/
106106
Possible use cases:
107107

108108
1. Walk CI for the latest 100 runs of `node-test-pull-request`,
109-
aggregate failures, write the results into a Markdown file,
110-
and then cache the responses from Jenkins so that the next time the command
111-
is run, it picks up cached data written on disk for jobs whose results
112-
are known.
109+
aggregate failures, write the results into a Markdown file,
110+
and then cache the responses from Jenkins so that the next time the command
111+
is run, it picks up cached data written on disk for jobs whose results
112+
are known.
113113

114-
Note: results are cached in `${ncu_installation_path}/.ncu/cache`, so you
115-
may want to clean it up from time to time.
114+
Note: results are cached in `${ncu_installation_path}/.ncu/cache`, so you
115+
may want to clean it up from time to time.
116116

117-
```
118-
ncu-ci walk pr --stats --cache --markdown results.md
119-
```
117+
```
118+
ncu-ci walk pr --stats --cache --markdown results.md
119+
```
120120

121121
2. Walk CI for the latest 100 runs of `node-test-pull-request`, and then write the
122-
failures into a JSON file named database.json.
122+
failures into a JSON file named database.json.
123123

124-
```
125-
ncu-ci walk pr --json database.json
126-
```
124+
```
125+
ncu-ci walk pr --json database.json
126+
```
127127

128128
### `ncu-ci pr <jobid>`
129129

0 commit comments

Comments
 (0)