Skip to content

Conversation

@tuhaihe
Copy link
Member

@tuhaihe tuhaihe commented Jun 20, 2025

This commit introduces a new GitHub Actions workflow that checks commit messages in pull requests against recommended style guidelines.

The workflow verifies:

  • Title length (50 characters or less)
  • Title starts with uppercase letter
  • Body is not empty
  • Body lines don't exceed 72 characters

The check provides helpful suggestions to contributors without preventing PR merging.

Fixes #ISSUE_Number

What does this PR do?

Type of Change

  • Bug fix (non-breaking change)
  • New feature (non-breaking change)
  • Breaking change (fix or feature with breaking changes)
  • Documentation update

Breaking Changes

Test Plan

  • Unit tests added/updated
  • Integration tests added/updated
  • Passed make installcheck
  • Passed make -C src/test installcheck-cbdb-parallel

Impact

Performance:

User-facing changes:

Dependencies:

Checklist

Additional Context

CI Skip Instructions


@tuhaihe tuhaihe force-pushed the commit-check branch 2 times, most recently from 3dae375 to 4a57911 Compare August 19, 2025 08:48
@tuhaihe
Copy link
Member Author

tuhaihe commented Aug 19, 2025

This commit introduces a new GitHub Actions workflow that checks
commit messages in pull requests against recommended style guidelines.

The workflow verifies:
- Title length (50 characters or less)
- Title starts with uppercase letter
- Body is not empty
- Body lines don't exceed 72 characters

The check provides helpful suggestions to contributors without
preventing PR merging.
Add comprehensive GitHub Copilot instructions to guide automated
commit message review in pull requests. The instructions define
standards for commit title format, body structure, and optional
trailers based on our .gitmessage template.

Key features include:
- Flexible title length rules (prefer 50, max 72 characters)
- Optional but recommended prefix usage (Fix:, Feature:, etc.)
- Emphasis on meaningful commit body content with what/why/how
- Proper trailer formatting guidelines
- Common issues flagging for automated review

This will help maintain consistent commit message quality across
the project while providing clear feedback to contributors.
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.

1 participant