Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
git-conventional-commits
Advanced tools
git-conventional-commits - npm Package Compare versions
Comparing version 1.0.1 to 1.0.2
@@ -16,3 +16,3 @@ { | ||
| "releaseTagGlobPattern": "v[0-9]*.[0-9]*.[0-9]*", | ||
| "issueRegexPattern": "[A-Z]{3,}-\\d+" | ||
| "issueRegexPattern": "(^|\\s)#\\d+(\\s|$)" | ||
| }, | ||
@@ -19,0 +19,0 @@ |
| { | ||
| "name": "git-conventional-commits", | ||
| "version": "1.0.1", | ||
| "version": "1.0.2", | ||
| "description": "git conventional commits util", | ||
@@ -5,0 +5,0 @@ "licence": "MIT", |
124
README.md
@@ -5,17 +5,7 @@ # Git Conventional Changelog Generator | ||
| **Please find attached [Git Commit Convention](#git-commit-convention)** | ||
| **[Git Commit Convention](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13)** | ||
| ### Install | ||
| ensure you've installed `npm` | ||
| * **macOS** `brew install node` | ||
| **with SSH**: | ||
| ensure you've called `ssh-add ~/.ssh/some_key_rsa` | ||
| `npm install -g git+ssh://git@github.com:qoomon/git-conventional-commits.git` | ||
| `npm install git-conventional-commits` | ||
| or | ||
| **with HTTPS**: | ||
| `npm install -g git+https://github.com/qoomon/git-conventional-commits.git` | ||
| ### Commands | ||
@@ -51,3 +41,3 @@ ``` | ||
| "releaseTagGlobPattern": "v[0-9]*.[0-9]*.[0-9]*", | ||
| "issueRegexPattern": "[A-Z]{3,}-\\d+" | ||
| "issueRegexPattern": "(^|\\s)#\\d+(\\s|$)" | ||
| }, | ||
@@ -73,5 +63,5 @@ | ||
| "commitUrl": "https://github.com/ACCOUNT/REPO/commit/%commit%", | ||
| "commitRangeUrl": "https://github.com/ACCOUNT/REPO/compare/%from%...%to%?diff=split", | ||
| "issueUrl": "https://JIRA_URL/browse/%issue%" | ||
| "commitUrl": "https://github.com/ACCOUNT/REPOSITORY/commit/%commit%", | ||
| "commitRangeUrl": "https://github.com/ACCOUNT/REPOSITORY/compare/%from%...%to%?diff=split", | ||
| "issueUrl": "https://github.com/ACCOUNT/REPOSITORY/issues/%issue%" | ||
| } | ||
@@ -156,105 +146,3 @@ } | ||
| --- | ||
| # Git Commit Convention | ||
| ## Commit Formats | ||
| ### Default | ||
| <pre> | ||
| <b><a href="#types"><type></a></b></font>(<b><a href="#scopes"><optional scope></a></b>): <b><a href="#subject"><subject></a></b> | ||
| <sub>empty separator line</sub> | ||
| <b><a href="#body"><optional body></a></b> | ||
| <sub>empty separator line</sub> | ||
| <b><a href="#footer"><optional footer></a></b> | ||
| </pre> | ||
| ### Merge | ||
| <pre> | ||
| Merge branch '<b><branch name></b>' | ||
| </pre> | ||
| <sup>Follows default git merge message</sup> | ||
| ### Revert | ||
| <pre> | ||
| Revert "<b><commit headline></b>" | ||
| <sub>empty separator line</sub> | ||
| This reverts commit <b><commit hash></b>. | ||
| <b><optinal reason></b> | ||
| </pre> | ||
| <sup>Follows default git revert message</sup> | ||
| ### Types | ||
| * API Relevant Changes **recognizable by your clients** | ||
| * `feat` Commits, that adds a new feature | ||
| * `fix` Commits, that fixes a bug | ||
| * `refactor` Commits, that rewrite/restructure your code, however does not change any behaviour | ||
| * `perf` Commits are `refactor` commit, that improves performance | ||
| * `style` Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc) | ||
| * `test` Commits, that add missing tests or correcting existing tests | ||
| * `doc` Commits, that affect documentation only | ||
| * `build` Commits, that affect build components like build tool, ci pipeline, dependencies, project version, ... | ||
| * `ops` Commits, that affect operational components like infrastructure, backup, recovery, ... | ||
| ### Scopes | ||
| The `scope` provides additional contextual information. | ||
| * Is an **optional** part of the format | ||
| * Allowed Scopes depends on the specific project | ||
| * Don't use issue identifiers as scopes | ||
| ### Subject | ||
| The `subject` contains a succinct description of the change. | ||
| * Is a **mandatory** part of the format | ||
| * Use the imperative, present tense: "change" not "changed" nor "changes" | ||
| * Don't capitalize the first letter | ||
| * No dot (.) at the end | ||
| ### Body | ||
| The `body` should include the motivation for the change and contrast this with previous behavior. | ||
| * Is an **optional** part of the format | ||
| * Use the imperative, present tense: "change" not "changed" nor "changes" | ||
| * This is the place to mention issue identifiers and their relations | ||
| ### Footer | ||
| The `footer` should contain any information about **Breaking Changes** and is also the place to **reference Issues** that this commit refers to. | ||
| * Is an **optional** part of the format | ||
| * **optionally** reference an issue by its id. | ||
| * **Breaking Changes** should start with the word `BREAKING CHANGES:` followed by space or two newlines. The rest of the commit message is then used for this. | ||
| ### Examples | ||
| * ``` | ||
| feat(shopping cart): add the amazing button | ||
| ``` | ||
| * ``` | ||
| feat: remove ticket list endpoint | ||
| refers to JIRA-1337 | ||
| BREAKING CHANGE: ticket enpoints no longer supports list all entites. | ||
| ``` | ||
| * ``` | ||
| fix: add missing parameter to service call | ||
| The error occurred because of <reasons>. | ||
| ``` | ||
| * ``` | ||
| build: release version 1.0.0 | ||
| ``` | ||
| * ``` | ||
| build: update dependencies | ||
| ``` | ||
| * ``` | ||
| refactor: implement calculation method as recursion | ||
| ``` | ||
| * ``` | ||
| style: remove empty line | ||
| ``` | ||
| * ``` | ||
| revert: refactor: implement calculation method as recursion | ||
| This reverts commit 221d3ec6ffeead67cee8c730c4a15cf8dc84897a. | ||
| ``` | ||
| --- | ||
| ###### Sources | ||
| * [qoomon - conventional commit messages](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13) | ||
| ## Build/Release | ||
@@ -261,0 +149,0 @@ * `npm install` |
New alerts
License Policy Violation
LicenseThis 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
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-9.31%
34866
- Number of lines in readme file
- decreased by-42.75%
150
No dependency changes