From d4470cdf6e602cb2e7efd3f03490f9bd33dacbc2 Mon Sep 17 00:00:00 2001 From: David Anson Date: Sat, 30 Mar 2024 21:06:54 -0700 Subject: [PATCH] Update CONTRIBUTING.md to link to a more relevant (my own) blog post about version pinning for dependencies. --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 64a7fa7f..015855c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. @@ -51,4 +52,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