diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 00000000000..e1bb87b9b33 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,116 @@ + + +# GitHub Copilot Instructions for Commit Message Review + +## Overview +When reviewing pull requests, please check commit messages against our project's commit message template and standards defined in `.gitmessage`. + +## Commit Message Review Guidelines + +### Title Module Requirements +- **Format**: Use imperative mood starting with uppercase letter +- **Length**: Preferably 50 characters or less, maximum 72 characters +- **Ending**: Do NOT end with a period +- **Prefixes**: Recommended prefixes (but not mandatory): + - `Fix:` for bug fixes, typos, and issue resolution + - `Feature:` for new feature implementations + - `Enhancement:` for code optimizations and improvements + - `Doc:` for documentation changes + - Any imperative verb starting with uppercase letter is acceptable + +### Body Module Requirements +- **Separation**: Must have a blank line between title and body +- **Content**: Ensure meaningful and substantial content. Ideally include: + - **What**: What changes were made + - **Why**: Why the changes were necessary + - **How**: How the changes were implemented (when relevant) +- **Compatibility**: Describe any compatibility issues if present +- **Line Length**: Maximum 72 characters per line + +### Trailers Module (Optional) +Check for proper formatting of optional trailers: +- `Reported-by: NAME` for bug reports from others +- `Co-authored-by: NAME ` for multiple authors +- `on-behalf-of: @ORG NAME@ORGANIZATION.COM` for organizational commits +- `See: Issue#id ` for GitHub Issues references +- `See: Discussion#id ` for GitHub Discussions references + +## Review Actions + +When reviewing commits in PRs: + +1. **Validate Title Format**: + - Check if title follows imperative mood with uppercase start + - Verify title length (prefer ≤50 chars, accept ≤72 chars) + - Confirm no trailing period + - Note: Prefixes like "Fix:" are recommended but not mandatory + +2. **Check Body Structure**: + - Verify blank line separation + - Validate line length (72 chars max) + - Ensure meaningful content that explains the change substantively + - Prefer inclusion of what/why/how when applicable + +3. **Review Trailers**: + - Validate trailer formatting if present + - Check URL validity for references + +4. **Provide Feedback**: + - Suggest corrections for non-compliant messages + - Offer specific examples of proper formatting + - Highlight which part of the template is violated + +## Example Good Commit Messages + +``` +Fix: resolve memory leak in query executor + +The query executor was not properly releasing memory allocated +for intermediate results when processing complex joins. This +change adds proper cleanup in the error handling paths and +ensures all allocated buffers are freed. + +Co-authored-by: Jane Doe +See: Issue#123 +``` + +``` +Feature: add support for parallel index creation + +Implements parallel index creation to improve performance on +large tables. The feature uses multiple worker processes to +build index segments concurrently, reducing creation time +by up to 60% on multi-core systems. + +See: Discussion#456 +``` + +## Common Issues to Flag + +- Title exceeding 72 characters (warn if over 50 characters) +- Title ending with period +- Title not starting with uppercase letter +- Missing blank line between title and body +- Body lines exceeding 72 characters +- Malformed trailer syntax +- Vague or insufficient commit descriptions lacking substance +- Non-imperative mood in title + +When suggesting improvements, always reference the specific section of our `.gitmessage` template that applies. \ No newline at end of file diff --git a/.github/workflows/commit-message-check.yml b/.github/workflows/commit-message-check.yml new file mode 100644 index 00000000000..15039c4eec6 --- /dev/null +++ b/.github/workflows/commit-message-check.yml @@ -0,0 +1,165 @@ +# -------------------------------------------------------------------- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed +# with this work for additional information regarding copyright +# ownership. The ASF licenses this file to You under the Apache +# License, Version 2.0 (the "License"); you may not use this file +# except in compliance with the License. You may obtain a copy of the +# License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. See the License for the specific language governing +# permissions and limitations under the License. +# +# -------------------------------------------------------------------- +# Commit Message Check +# -------------------------------------------------------------------- +# Checks the commit messages for a pull request to ensure they follow +# the project's guidelines. This is not a required check and will not +# block the PR from being merged. It provides suggestions for improving +# commit messages. +# +# The main checks include: +# * Title length (recommended: 50 characters or less) +# * Title capitalization (should start with an uppercase letter) +# * Body presence (should not be empty) +# * Body line length (recommended: 72 characters or less) +# -------------------------------------------------------------------- + +name: Commit Message Check + +on: + pull_request: + types: [opened, synchronize, reopened, edited] + +permissions: + contents: read + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +env: + MAX_TITLE_LENGTH: 50 + MAX_BODY_LINE_LENGTH: 72 + MAX_COMMITS_TO_CHECK: 20 + +jobs: + check-commit-message: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Check commit messages + shell: bash + run: | + # Don't exit on errors - we want to check all commits + set +e + + # Get PR commits with limit + PR_COMMITS=$(git log --format="%H" ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }} | head -${MAX_COMMITS_TO_CHECK}) + + # Check if there are any commits + if [[ -z "$PR_COMMITS" ]]; then + echo "## Commit Message Style Check" >> $GITHUB_STEP_SUMMARY + echo "No commits found in this PR!" >> $GITHUB_STEP_SUMMARY + exit 0 + fi + + COMMIT_COUNT=$(echo "$PR_COMMITS" | wc -l) + + echo "## Commit Message Style Check" >> $GITHUB_STEP_SUMMARY + echo "⏰ Non-mandatory suggestions for reference only." >> $GITHUB_STEP_SUMMARY + echo "Checking $COMMIT_COUNT commit(s)" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + + HAS_ISSUES=false + + for COMMIT in $PR_COMMITS; do + # Get commit info with error handling + TITLE=$(git log --format="%s" -n 1 "$COMMIT" 2>/dev/null || echo "Warning: unable to read commit title") + BODY=$(git log --format="%b" -n 1 "$COMMIT" 2>/dev/null || echo "") + RAW=$(git log --format="%B" -n 1 "$COMMIT" 2>/dev/null || echo "Warning: unable to read commit message") + + echo "### Checking commit: ${COMMIT:0:8}" >> $GITHUB_STEP_SUMMARY + echo '```' >> $GITHUB_STEP_SUMMARY + echo "$RAW" >> $GITHUB_STEP_SUMMARY + echo '```' >> $GITHUB_STEP_SUMMARY + + ISSUES=() + + # Check title length + if [[ ${#TITLE} -gt ${MAX_TITLE_LENGTH} ]]; then + ISSUES+=("- Title length is ${#TITLE} characters (recommended: ${MAX_TITLE_LENGTH} or less)") + fi + + # Check title capitalization + if [[ ! $TITLE =~ ^[A-Z] ]]; then + ISSUES+=("- Title should start with an uppercase letter") + fi + + # Check body is not empty (optional for simple fixes) + if [[ -z "$BODY" || "$BODY" =~ ^[[:space:]]*$ ]]; then + # Only suggest body for non-trivial commits + if [[ ! $TITLE =~ (typo|whitespace|comment|indentation) ]]; then + ISSUES+=("- Consider adding a commit body for better context") + fi + fi + + # Check body line length + if [[ -n "$BODY" ]]; then + LONG_LINES=0 + while IFS= read -r line; do + if [[ ${#line} -gt ${MAX_BODY_LINE_LENGTH} && -n "$line" ]]; then + ((LONG_LINES++)) + fi + done <<< "$BODY" + + if [[ $LONG_LINES -gt 0 ]]; then + ISSUES+=("- Found $LONG_LINES line(s) in body exceeding ${MAX_BODY_LINE_LENGTH} characters") + fi + fi + + # Skip to next commit if there's a warning reading this one + if [[ "$TITLE" == "Warning: unable to read commit title" ]]; then + echo "⚠️ Warning: unable to read commit $COMMIT, skipping..." >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + continue + fi + + # Output issues + if [[ ${#ISSUES[@]} -gt 0 ]]; then + HAS_ISSUES=true + echo "⚠️ **Suggestions:**" >> $GITHUB_STEP_SUMMARY + for issue in "${ISSUES[@]}"; do + echo "$issue" >> $GITHUB_STEP_SUMMARY + done + echo "" >> $GITHUB_STEP_SUMMARY + else + echo "✅ Commit message follows recommended style" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + fi + done + + echo "---" >> $GITHUB_STEP_SUMMARY + + if [[ "$HAS_ISSUES" == "true" ]]; then + echo "" >> $GITHUB_STEP_SUMMARY + echo "## 📝 Note" >> $GITHUB_STEP_SUMMARY + echo "These suggestions are for reference only and won't block PR merging." >> $GITHUB_STEP_SUMMARY + echo "Please refer to the project's .gitmessage template for detailed guidelines." >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "❌ **Some commits have style suggestions - please review above.**" >> $GITHUB_STEP_SUMMARY + exit 1 + else + echo "" >> $GITHUB_STEP_SUMMARY + echo "🎉 All commits follow the recommended guidelines!" >> $GITHUB_STEP_SUMMARY + exit 0 + fi