chore: add husky pre-commit commit message validator #779
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
Adds validation to commits performed locally so that commit messages conform to the standards of Conventional Commits.
Member
Author
|
Bumping @KrisJordan |
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.
This PR adds a local commit validator to the CSXL repo so that commits made locally only succeed if they follow the standards of the Conventional Commit format. I have noticed this as a standard in some larger open-source projects, and I have adopted this in Dabblebase and in some other projects. I think there is educational value too, since many large organizations will have a standard that they want employees to follow. There are also some niceties with conventional commits that are valuable in larger projects.
In addition, the dev container is modified to both install the necessary packages to make this work immediately after container creation, but also runs
cd frontend; npm install; cd ..immediately as a post-creation step, ensuring node modules are up-to-date after container launch. Husky runs in a small Node environment globally in the project, but this does not interfere with the frontend node modules.