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

On hotfix: add pre-commit config to enforce conventional commits style #36

Merged
merged 1 commit into from
Aug 18, 2023

Conversation

kelly-sovacool
Copy link
Member

This pre-commit config file contains a git hook to enforce the conventional commits style. After you pull these changes locally and install pre-commit (via pip, conda, or brew), install this hook with pre-commit install. Then it will check your commit message every time you attempt to commit and throw an error if it doesn't follow conventional commits guidelines.

(I accidentally opened #35 against main instead of hotfix)

@kelly-sovacool kelly-sovacool added the enhancement New feature or request label Aug 18, 2023
@dnousome dnousome merged commit ece89cf into hotfix Aug 18, 2023
2 checks passed
@dnousome
Copy link
Collaborator

Looks very helpful! Tried locally using a conda env and worked for me

@kelly-sovacool kelly-sovacool deleted the precommit branch August 21, 2023 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants