Skip to content

Commit

Permalink
Update CONTRIBUTING.md to link to a more relevant (my own) blog post …
Browse files Browse the repository at this point in the history
…about version pinning for dependencies.
  • Loading branch information
DavidAnson committed Apr 4, 2024
1 parent b22040a commit 349248f
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@ preferences and opinions, a pull request is not the right forum to debate them.

Package versions for `dependencies` and `devDependencies` should be specified
exactly (also known as "pinning"). The short explanation is that doing otherwise
eventually leads to inconsistent behavior and broken functionality. (See [Pin
your npm/yarn dependencies][pin-dependencies] for a longer explanation.)
eventually leads to inconsistent behavior and broken functionality. (See [Why I
pin dependency versions in Node.js packages][version-pinning] for a longer
explanation.)

Add tests for all new/changed functionality. Test positive and negative
scenarios. Try to break the code now, or else it will get broken later.
Expand Down Expand Up @@ -48,4 +49,4 @@ Thank you!
[example-com]: https://en.wikipedia.org/wiki/Example.com
[github-issues]: https://github.com/DavidAnson/markdownlint-cli2/issues
[linking-pull-request]: https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
[pin-dependencies]: https://maxleiter.com/blog/pin-dependencies
[version-pinning]: https://dlaa.me/blog/post/versionpinning

0 comments on commit 349248f

Please sign in to comment.