Skip to content

docs(git-commit): add git commit message specification document#59

Merged
alikia2x merged 1 commit into
mainfrom
chore/aibeto-main-git_message
May 16, 2026
Merged

docs(git-commit): add git commit message specification document#59
alikia2x merged 1 commit into
mainfrom
chore/aibeto-main-git_message

Conversation

@Aibeto

@Aibeto Aibeto commented May 16, 2026

Copy link
Copy Markdown
Member

Changes

add the full git commit message specification rules file to the project

  • Added .trae/rules/git-commit-message.md - a Git commit message specification document that defines standardized commit message format for the project
  • Specified the required commit message structure: <type>(<scope>): <description> with optional body and footer sections
  • Defined 11 allowed commit types: feat, fix, update, docs, style, refactor, perf, test, ci, chore, and revert with descriptions for each
  • Included practical examples demonstrating proper commit message formatting, including examples with breaking changes
  • Documented rules for each component (type, scope, description) with requirements such as English-only text, imperative mood, and present tense
  • Configured the rule with alwaysApply: true and scene: git_message to enable automatic application

Review Change Stack

add the full git commit message specification rules file to the project
@coderabbitai

coderabbitai Bot commented May 16, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: ebc1aa4f-30b9-44a6-a5ce-4a045649f8b3

📥 Commits

Reviewing files that changed from the base of the PR and between 829c8d9 and 7eb098b.

📒 Files selected for processing (1)
  • .trae/rules/git-commit-message.md

📝 Walkthrough

Walkthrough

This pull request adds a Trae rule file that defines and enforces a standardized Git commit message format for the project. The rule specifies an English-only structure with header, optional body and footer sections, and enumerates the permitted commit types with usage examples.

Changes

Git Commit Message Rule

Layer / File(s) Summary
Git commit message rule definition
.trae/rules/git-commit-message.md
Trae rule file specifying the required English commit message format with type/scope/description header, optional body and footer, permitted commit type list, and example commit messages.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • project-cvsa/cvsa#56: Both PRs add/adjust the same .trae/rules/git-commit-message.md file to enforce a Conventional Commits-style Git commit message format and allowed type list.

Suggested reviewers

  • alikia2x
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/aibeto-main-git_message

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@alikia2x alikia2x left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

marvelous

@alikia2x alikia2x merged commit c4f9019 into main May 16, 2026
1 check passed
@alikia2x alikia2x deleted the chore/aibeto-main-git_message branch May 16, 2026 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants