feat: add commit message standardization (#36)#41
Merged
c-vigo merged 10 commits intofeature/37-automate-standardize-repository-setupfrom Feb 2, 2026
Merged
Conversation
- Introduced a comprehensive document outlining the commit message format for the repository. - Defined structure, approved types, and compliance requirements to ensure consistency and traceability. - Included guidelines for enforcing the standard in development environments and CI. Refs: #36
- Introduced a new script to validate commit messages against the project's standard. - Added a corresponding test suite to ensure the validation logic works correctly. - Added test recipe to justfile - Updated documentation to include the new validation command in the available recipes. Refs: #36
- Modified init.sh to Install git template locally during project setup Refs: #36
- Introduced a detailed guide for the Git commit workflow, outlining steps for analyzing staged changes and writing accurate commit messages. - Added rules for commit message formatting, including mandatory structure and compliance requirements to ensure consistency. Refs: #36
- Introduced a new commit-msg hook script to enforce commit message standards when committing within the development container. - Updated init.sh to ensure the new hook is executable during setup. Refs: #36
- Updated commit message guidelines to eliminate the requirement for a trailing newline at the end of the message. - Adjusted validation logic and corresponding tests to reflect this change, ensuring commit messages can be valid without a trailing newline. Refs: #36
- Added a new hook to validate commit messages during the commit-msg stage, ensuring adherence to the project's standards. - The hook executes a Python script to perform the validation. Refs: #36
caf172d
into
feature/37-automate-standardize-repository-setup
1 check passed
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
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.
Pull Request
Description
This PR merges commit message standardization (#36) into the automate-repository-setup branch (#37). It adds a documented commit message format, validation (Python script + commit-msg hook), Cursor integration, and workspace template updates so new repos get the same standard.
Related Issue(s)
Closes #36
Related to #37
Type of Change
Changes Made
docs/COMMIT_MESSAGE_STANDARD.mdand workspace copy: formattype(scope)!: subject, mandatoryRefs: #<issue>, approved types, traceability (REQ-/RISK-/SOP-).scripts/validate_commit_msg.py: validates subject, blank line, single Refs line with at least one#issue; used by commit-msg hook and tests..githooks/commit-msg(repo andassets/workspace/.githooks/commit-msg): runs validation; workspace hook checksIN_CONTAINERand calls validator..pre-commit-config.yaml(repo) and workspace pre-commit config:validate-commit-msghook.scripts/init.sh: setscore.hooksPath .githooks,chmod +xfor pre-commit and commit-msg, andcommit.template .gitmessage..gitmessage(repo and workspace): subject + Refs placeholder..cursor/rules/commit-messages.mdc,.cursor/commands/commit-msg.md(repo and workspace): rules and slash command for commit workflow.assets/workspace/.devcontainer/scripts/setup-git-conf.sh: setscommit.templatewhen.gitmessageexists.tests/test_validate_commit_msg.py: valid/invalid messages; integration tests for commit-msg hook in workspace.test-validate-commit-msg, commit standard reference.Testing
just test)Manual Testing Details
just test-validate-commit-msgpasses.git commit -m "invalid") is rejected by commit-msg hook.feat: add x+ blank line +Refs: #36) is accepted.Checklist
[Unreleased]sectionAdditional Notes
feature/37-automate-standardize-repository-setup