conventional-release-setup - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

CHANGELOG.md

@@ -5,2 +5,4 @@ # Changelog
 
+### [1.0.1](https://github.com/remarkablemark/conventional-release-setup/compare/v1.0.0...v1.0.1) (2020-03-24)
+
 ## 1.0.0 (2020-02-17)
@@ -7,0 +9,0 @@

package.json

 {
   "name": "conventional-release-setup",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Sets up package for committing/releasing with conventional commits.",
@@ -5,0 +5,0 @@ "author": "Mark <[e-mail]>",

README.md

@@ -41,2 +41,29 @@ # conventional-release-setup
 
+What does this script do?
+
+It installs the devDependencies:
+
+- [@commitlint/cli](https://www.npmjs.com/package/@commitlint/cli) - lints commit messages
+- [@commitlint/config-conventional](https://www.npmjs.com/package/@commitlint/config-conventional) - config with [conventional commits](https://conventionalcommits.org/) rules
+- [husky](https://www.npmjs.com/package/husky) - sets up Git hooks
+- [standard-version](https://www.npmjs.com/package/standard-version) - generates changelog and bumps version
+
+And copies the configs to your project root:
+
+- [.commitlintrc.json](https://github.com/remarkablemark/conventional-release-setup/blob/master/files/.commitlintrc.json)
+- [.huskyrc](https://github.com/remarkablemark/conventional-release-setup/blob/master/files/.huskyrc)
+
+For your first release, it's recommended to do the following:
+
+```sh
+# git stash
+$ npm version 1.0.0
+$ git add package.json
+$ git commit -m 'chore(package): bump version to 1.0.0'
+$ npx standard-version --first-release
+# git stash pop
+```
+
+See [standard-version > First Release](https://github.com/conventional-changelog/standard-version#first-release) for more details.
+
 ## Release
@@ -43,0 +70,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6911

increased by22.3%

Lines of code

56

increased by9.8%

Number of lines in readme file

80

increased by50.94%

No dependency changes