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

ci(pre-commit): enforce conventional-commits message structure #164

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

greenkiwi
Copy link
Contributor

This adds pre-commit and ci checks to ensure that commit messages follow
conventional-commits.

From their site: Conventional Commits is:
A specification for adding human and machine readable meaning to commit messages

Commit messages must follow the following format:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

In general, this means that you will provide a topic:

  • feat
  • fix
  • ci
  • refactor

Followed by a description.

Following this standard allows for automatic semantic versioning and
release note generation.

  • .commitlintrc.yaml - defines the commit message format for linting
  • .cz.json - configuration for commitizen-cli

Description of the change

Description here

Type of change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklists

Development

  • Lint rules pass locally
  • The code changed/added as part of this pull request has been covered with tests
  • All tests related to the changed code pass in development

Code review

  • This pull request has a descriptive title and information useful to a reviewer. There may be a screenshot or screencast attached
  • Jira issue referenced in commit message and/or PR title

Testing

Description of testing

Sorry, something went wrong.

@greenkiwi greenkiwi requested a review from wcmjunior February 23, 2022 04:01
@greenkiwi greenkiwi closed this Feb 23, 2022
@greenkiwi greenkiwi deleted the conventional-commits branch February 23, 2022 04:05
@greenkiwi greenkiwi restored the conventional-commits branch February 23, 2022 04:05
@greenkiwi greenkiwi reopened this Feb 23, 2022
This adds pre-commit and ci checks to ensure that commit messages follow
[`conventional-commits`](https://www.conventionalcommits.org/en/v1.0.0/).

From their site: Conventional Commits is:
`A specification for adding human and machine readable meaning to commit messages`

Commit messages must follow the following format:
```
<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
```

In general, this means that you will provide a topic:
* feat
* fix
* ci
* refactor

Followed by a description.

Following this standard allows for automatic semantic versioning and
release note generation.

* `.commitlintrc.yaml` - defines the commit message format for linting
* `.cz.json` - configuration for [`commitizen-cli`](http://commitizen.github.io/cz-cli/)
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

Successfully merging this pull request may close these issues.

None yet

2 participants