I was going through updating dependencies for our library and was very confused when I saw npm had installed v2.11.0 (even for ^2.4.0-cloc) but wanted 2.6.0-cloc. Even looking at the npm releases page it was unclear why the npm version "went backward" and why the -cloc suffix was added. It wasn't until some digging and found #26 and #30 that I understood.
- Please automatically generate releases on Github so it's clear these releases were intentional when looking at Github. Right now it still shows
2.11.0 as the "latest"
- The release notes could be as simple as "Updated to cloc version ###. See the changelog here"
- This is also important for identifying breaking changes or new features. Right now this is completely hidden from users of the
npm package without knowing to jump over to the other repository.
- Add a section to the readme explaining the version strategy.
- It should be clear to users why the versions look the way they do and that the major/minor should match the main
cloc versions. (little confusing that they use 2.06 but this package is 2.6.0 but that's minor)
I was going through updating dependencies for our library and was very confused when I saw npm had installed
v2.11.0(even for^2.4.0-cloc) but wanted2.6.0-cloc. Even looking at the npm releases page it was unclear why the npm version "went backward" and why the-clocsuffix was added. It wasn't until some digging and found #26 and #30 that I understood.2.11.0as the "latest"npmpackage without knowing to jump over to the other repository.clocversions. (little confusing that they use2.06but this package is2.6.0but that's minor)