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.

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

Help info contains conflicting default values for --preset option #406

Closed
matatk opened this issue Jul 22, 2019 · 1 comment · Fixed by #413
Closed

Help info contains conflicting default values for --preset option #406

matatk opened this issue Jul 22, 2019 · 1 comment · Fixed by #413

Comments

@matatk
Copy link

matatk commented Jul 22, 2019

The help output for 6.0.1 states:

  --preset             Commit message guideline preset (default: angular)
                                                        [string] [default: "conventionalcommits"]

I gather the default was changed in 6.0.0 to conventionalcommits, but it looks like the reference to angular was not removed.

Thanks for this tool—it's great, and I am really excited to use it since #208 was fixed, as I want to ensure my changelogs are as accessible (e.g. to screen-reader users) as possible. Previously I had written a wrapper for conventional-changelog that modified the heading structure (and did some other stuff that's now supported via the new configuration options), but am looking forward to moving to using standard-version).

Update: was just looking at the README and noticed the README also mentions that standard-version is based on the Angular format by default. If this is a separate issue, I'd be happy to file it.

@jbottigliero
Copy link
Member

Hey, thanks for the report! A fix for --help output will land in the next version (#377), I've just opened a PR removing the mention of the Angular convention from the README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging a pull request may close this issue.

2 participants