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

feat: add subject-exclamation-mark rule to improve error messages #2593

Merged

Commits on May 24, 2021

  1. feat: add subject-exclamation-mark rule to improve error messages

    When using the conventional commit feature of an `!` in the commit
    subject the angular config get really confused and gives some error
    messages that do not relate to the issue due to the message failing at
    the parse stage. This overrides the angular parser preset to add in
    the exclamation mark then uses the new rule to give a better error
    message.
    
    The result is with the message "fix!: the fix" previously the error
    message would be "subject may not be empty" now the error message is
    "subject must not have an exclamation mark in the subject to identify
    a breaking change". This message it more descriptive and will give the
    user info they need to resolve the issue.
    
    This also updates the docs to highlight the difference in angular and
    conventional configs, and point them in the direction of the
    conventional config if they want to use the `!` in the commit messages
    AdeAttwood committed May 24, 2021
    Copy the full SHA
    180d82b View commit details
    Browse the repository at this point in the history