build: add commitizen to pre-commit and document guidelines#4796
Open
AleNunezArroyo wants to merge 1 commit into
Open
build: add commitizen to pre-commit and document guidelines#4796AleNunezArroyo wants to merge 1 commit into
AleNunezArroyo wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview: What does this pull request change?
This pull request integrates Commitizen into the pre-commit workflow and provides documentation for the repository's commit message format guidelines.
Specifically, it:
pyproject.toml.commitizenhook under thecommit-msgstage in.pre-commit-config.yaml.docs/source/contributing/commits.md.docs/source/contributing/development.mdto link to the new guidelines.Motivation and Explanation: Why and how do your changes improve the library?
This change enforces consistent and descriptive commit messages conforming to the Conventional Commits specification. Having structured commits enables automated changelog generation, better readability of the project history, and easier semantic versioning management.
Links to added or changed documentation pages
docs/source/contributing/commits.mddocs/source/contributing/development.mdFurther Information and Comments
Closes #4748
Reviewer Checklist