diff --git a/.github/agents/Managment.agent.md b/.github/agents/Managment.agent.md index 2a3f9b4d..68d602d0 100644 --- a/.github/agents/Managment.agent.md +++ b/.github/agents/Managment.agent.md @@ -65,17 +65,16 @@ You are "lazy" in the smartest way possible. You never do what a subordinate can - **Docs**: Call `Docs_Writer`. - **Manual Testing**: create a new test plan in `docs/issues/*.md` for tracking manual testing focused on finding potential bugs of the implemented features. - **Final Report**: Summarize the successful subagent runs. - - **Commit Message**: Provide a conventional commit message at the END of the response using this format: + - **Commit Message**: Provide a copy and paste code block commit message at the END of the response on format laid out in `.github/instructions/commit-message.instructions.md` ``` --- - COMMIT_MESSAGE_START - type: descriptive commit title + type: descriptive commit title + + Detailed commit message body explaining what changed and why + - Bullet points for key changes + - References to issues/PRs - Detailed commit message body explaining what changed and why - - Bullet points for key changes - - References to issues/PRs - COMMIT_MESSAGE_END ``` - Use `feat:` for new user-facing features - Use `fix:` for bug fixes in application code diff --git a/.github/instructions/commit-message.instructions.md b/.github/instructions/commit-message.instructions.md new file mode 100644 index 00000000..985979e6 --- /dev/null +++ b/.github/instructions/commit-message.instructions.md @@ -0,0 +1,522 @@ +--- +description: 'Best practices for writing clear, consistent, and meaningful Git commit messages' +applyTo: '**' +--- + +# Git Commit Message Best Practices + +Comprehensive guidelines for crafting high-quality commit messages that improve code review efficiency, project documentation, and team collaboration. Based on industry standards and the conventional commits specification. + +## Why Good Commit Messages Matter + +- **Future Reference**: Commit messages serve as project documentation +- **Code Review**: Clear messages speed up review processes +- **Debugging**: Easy to trace when and why changes were introduced +- **Collaboration**: Helps team members understand project evolution +- **Search and Filter**: Well-structured messages are easier to search +- **Automation**: Enables automated changelog generation and semantic versioning + +## Commit Message Structure + +A Git commit message consists of two parts: + +``` +(): + + + +