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

Documentation details #5

Open
Kraymer opened this issue Apr 19, 2020 · 1 comment
Open

Documentation details #5

Kraymer opened this issue Apr 19, 2020 · 1 comment

Comments

@Kraymer
Copy link

Kraymer commented Apr 19, 2020

Hello thanks for this package.
I recently started to use lib python-semantic-release and it needs correctly formatted commits to work well.

2 suggestions to your README.md :

  • mention it is python 3 only. I first did a pip install that failed but pip3 install succeeded
  • mention that the convention used by default in the hook is the Angular Commit Message Conventions
@jpSimkins
Copy link

To add to this, conventional commits are case-insensitive and this script is case-sensitive. This may be in point with the Angular Commit Messages Conventions mentioned above but it needs to be pointed out that this is against the docs of conventional commits.

The units of information that make up conventional commits MUST NOT be treated as case sensitive by implementors, with the exception of BREAKING CHANGE which MUST be uppercase.

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

No branches or pull requests

2 participants