actions/markdownlint-cli2-action
0
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint-cli2-action.git synced 2024-11-21 13:51:28 +01:00
Code Activity

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-04-03 22:08:55 -07:00
parent b22040a8c6
commit 349248f55f
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.md
View file

@ -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.
@ -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