Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add semver link, fix typos #740

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: add semver link, fix typos #740

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fee57d5
docs: add semver link, fix typos
patrickp-at-work Jan 15, 2021
8e7d9eb
Merge branch 'master' into patch-1
patrickp-at-work Mar 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/conventional-changelog-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

*[Changelog?](https://speakerdeck.com/stevemao/compose-a-changelog)*

**Note** You don't have to use the angular commit convention. For the best result of the tool to tokenize you commit and produce flexible output, it's recommended to use a commit convention.
**Note** You don't have to use the angular commit convention. For the best result of the tool to tokenize your commit and produce flexible output, it's recommended to use a commit convention.


## Quick start
Expand All @@ -17,7 +17,7 @@ $ cd my-project
$ conventional-changelog -p angular -i CHANGELOG.md -s
```

This will *not* overwrite any previous changelogs. The above generates a changelog based on commits since the last semver tag that matches the pattern of "Feature", "Fix", "Performance Improvement" or "Breaking Changes".
This will *not* overwrite any previous changelogs. The above generates a changelog based on commits since the last [SemVer](https://semver.org) tag that matches the pattern of "Feature", "Fix", "Performance Improvement" or "Breaking Changes".

If this is your first time using this tool and you want to generate all previous changelogs, you could do

Expand Down Expand Up @@ -75,7 +75,7 @@ You could follow the following workflow
1. Run the [`npm version [patch|minor|major]`](https://docs.npmjs.com/cli/version) command
1. Push

You could optionally add a `preversion` script to package your project or running a full suit of test.
You could optionally add a `preversion` script to package your project or running a full suite of tests.
And a `postversion` script to clean your system and push your release and tags.

By adding a `.npmrc` you could also automate your commit message and set your tag prefix as such:
Expand Down