Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-22 05:40:48 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Update CONTRIBUTING.md to link to a more relevant (my own) blog post about version pinning for dependencies.

Browse source
This commit is contained in:
David Anson 2024-03-17 14:13:05 -07:00
parent d5994ae4de
commit 3acf7da822
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.md
View file

@ -19,8 +19,9 @@ project's only dependencies.
Package versions for `dependencies` and `devDependencies` should be specified Package versions for `dependencies` and `devDependencies` should be specified
exactly (also known as "pinning"). The short explanation is that doing otherwise exactly (also known as "pinning"). The short explanation is that doing otherwise
eventually leads to inconsistent behavior and broken functionality. (See [Pin eventually leads to inconsistent behavior and broken functionality. (See [Why I
your npm/yarn dependencies][pin-dependencies] for a longer explanation.) pin dependency versions in Node.js packages][version-pinning] for a longer
explanation.)
If developing a new rule, start by creating a [custom rule][custom-rules] in its If developing a new rule, start by creating a [custom rule][custom-rules] in its
own project. Once written, published, and tested in real world scenarios, open own project. Once written, published, and tested in real world scenarios, open
@ -88,5 +89,5 @@ Thank you!
[micromark]: https://www.npmjs.com/package/micromark [micromark]: https://www.npmjs.com/package/micromark
[new-rule]: https://github.com/DavidAnson/markdownlint/labels/new%20rule [new-rule]: https://github.com/DavidAnson/markdownlint/labels/new%20rule
[npm-scripts]: https://docs.npmjs.com/misc/scripts [npm-scripts]: https://docs.npmjs.com/misc/scripts
[pin-dependencies]: https://maxleiter.com/blog/pin-dependencies
[rewriting-history]: https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History [rewriting-history]: https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History
[version-pinning]: https://dlaa.me/blog/post/versionpinning