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

chore: add precommit to check conventional commit #123

Closed
wants to merge 1 commit into from

Conversation

Weimw
Copy link

@Weimw Weimw commented Aug 24, 2023

To finish setup:

  1. Install precommit (https://pre-commit.com/). Run pip install pre-commit (For macOS, brew install pre-commit)
  2. Run pre-commit install --hook-type commit-msg

@davidvonthenen
Copy link
Contributor

I took a look at this PR and although the PR is marked as Draft, the intention is to use https://pre-commit.com/ to run linters, code checks, etc on open PRs to provide feedback to the user.

This is a good idea, but we should:

  1. provide the tools for the developer to automatically update their code changes with linters, checks, etc prior to submitting the PR. This gives the developer the ability to see the changes, commit the changes, and test the changes locally.
  2. then use those same tools to block the merge should changes need to made. It's important that the same toolchain be used in order to prevent both toolchains from pointing to each others with "errors".

Pre-commit looks like to address item 2, but not item 1.

@davidvonthenen
Copy link
Contributor

Will revisit this topic a little later. Closing this out for now since the direction has changed some.

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.

3 participants