Skip to content

Commit 95f2c89

Browse files
committed
docs: fix formatting in CONTRIBUTING.md and README.md
1 parent 3a95bfe commit 95f2c89

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
First of all, many thanks for considering making a contribution to this project.
33

44
# Submitting PRs
5-
Please do not include any changes to `package-lock.json` in your PRs, even if you are updating package.json. These changes are almost impossible to review for security implications. If necessary, `package-lock.json` will be regenerated and committed by a maintainer after your PR is merged.
5+
Please do not include any changes to `package-lock.json` in your PRs, even if you are updating `package.json`. These changes are almost impossible to review for security implications. If necessary, `package-lock.json` will be regenerated and committed by a maintainer after your PR is merged.
66

77
Please run the tests before submitting your pull request.
88

9-
`npm run lint`
10-
`npm test`
9+
* `npm run lint`
10+
* `npm test`
1111

12-
# Known bugs
12+
# Known issues
1313
[GitHub search](https://github.com/Mermade/oas-kit/search?utf8=%E2%9C%93&q=fixme+language%3Ajavascript&type=)

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This is the mono-repo for the following related projects
2121

2222
## Supported Node.js versions
2323

24-
Any LTS version. It is **not** recommended to use Node.js 12.17.x,12.18.x or 12.19.x due to an http2 bug.
24+
Any LTS version. It is **not** recommended to use Node.js 12.17.x,12.18.x or 12.19.x due to an [http2 bug](https://github.com/nodejs/node/issues/28001).
2525

2626
## Development
2727

@@ -30,7 +30,7 @@ Any LTS version. It is **not** recommended to use Node.js 12.17.x,12.18.x or 12.
3030
* `npx lerna bootstrap`
3131

3232
Please try and keep commits related to a single package or piece of functionality. Please review the
33-
(CONTRIBUTING.md)[CONTRIBUTING.md] for additional details.
33+
[CONTRIBUTING.md](CONTRIBUTING.md) for additional details.
3434

3535
## Supporting development
3636

0 commit comments

Comments
 (0)