Add precommit and git conventions #775
Merged
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
This commit updates the process documentation for how git is used, and explains our use of conventional commits and message formatting. It also includes an initial pre-commit configuration to enforce standards, which will be used to invoke other linters.
github-actions
bot
added
tooling
✅ Deploy Preview will be available once build job completes!
|
JTorreG
approved these changes
Jul 2, 2025
ADubhlaoich
commented
Jul 2, 2025
pdabelf5
approved these changes
Jul 2, 2025
JTorreG
approved these changes
Jul 2, 2025
travisamartin
approved these changes
Jul 2, 2025
lamATnginx
pushed a commit
that referenced
this pull request
Jul 15, 2025
This commit moves our git conventions to their own discrete page, and adds information that was previously not written down anywhere, such as our general branch management strategy. Beyond documenting these conventions, an initial pre-commit configuration has been added, which can be used as a guardrail to enforce some of the conventions, such as requirements around commit message length. A hook provided by the pre-commit maintainers is also configured to prevent commits directly to the main branch. These configurations may be adjusted in the future based on feedback, and there is additional follow-up work to add a template for the git commit message. I had a working implementation but decided to scrap it in favour of minimising the number of dependencies.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Proposed changes
This pull request moves our git conventions to their own discrete page, and adds information that was previously
not written down anywhere, such as our general branch management strategy.
Beyond documenting these conventions, an initial pre-commit configuration has been added, which can be used
as a guardrail to enforce some of the conventions, such as requirements around commit message length. A hook
provided by the pre-commit maintainers is also configured to prevent commits directly to the
mainbranch.These configurations may be adjusted in the future based on feedback, and there is additional follow-up work to
add a template for the git commit message. I had a working implementation but decided to scrap it in favour of
minimising the number of dependencies.
Checklist
Before merging a pull request, run through this checklist and mark each as complete.
README.mdandCHANGELOG.mdFootnotes
Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content. ↩