deepgram-dotnet-sdk icon indicating copy to clipboard operation
deepgram-dotnet-sdk copied to clipboard

chore: add precommit to check conventional commit

Open Weimw opened this issue 1 year ago • 1 comments

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

Weimw avatar Aug 24 '23 21:08 Weimw

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.

dvonthenen avatar Feb 12 '24 19:02 dvonthenen

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

dvonthenen avatar Jun 27 '24 14:06 dvonthenen