Skip to content

Add AI contribution commit trailer guidelines - #10243

Open
dev-hari-prasad wants to merge 2 commits into
pgadmin-org:masterfrom
dev-hari-prasad:docs/add-ai-commit-trailer-guideline
Open

Add AI contribution commit trailer guidelines#10243
dev-hari-prasad wants to merge 2 commits into
pgadmin-org:masterfrom
dev-hari-prasad:docs/add-ai-commit-trailer-guideline

Conversation

@dev-hari-prasad

@dev-hari-prasad dev-hari-prasad commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds guidance to CONTRIBUTING.md requesting contributors to include commit trailers (e.g., Co-Authored-By, Generated-by) when AI tools are used in preparing PRs.

Background & Rationale

  • Inspiration: Inspired by Apache Kafka's AI contribution guidelines.
  • Makes tracking AI-assisted contributions quantitative, giving clarity on AI usage across pull requests.

Summary by CodeRabbit

  • Documentation
    • Added contribution guidance for disclosing AI-assisted work.
    • Included supported commit trailer examples and a sample commit format.

@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 5dcfaf75-72ff-4c56-8d7b-f157434e9e32

📥 Commits

Reviewing files that changed from the base of the PR and between d6e1552 and ede59e8.

📒 Files selected for processing (1)
  • CONTRIBUTING.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • CONTRIBUTING.md

Walkthrough

The contribution guide now instructs contributors to record AI-tool usage in commit trailers. It includes supported trailer formats and a sample commit.

Changes

AI Contribution Guidance

Layer / File(s) Summary
Document AI usage commit trailers
CONTRIBUTING.md
The guide adds instructions and examples for recording AI-tool usage with Co-Authored-By, Generated-by, or similar commit trailers.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the addition of AI contribution commit trailer guidance.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CONTRIBUTING.md`:
- Around line 82-85: Update both fenced code blocks in the commit-message
examples in CONTRIBUTING.md to specify the text language identifier, including
the block containing Co-Authored-By and Generated-by and the block containing
the issue-title example, while leaving their contents unchanged.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 34ffc72c-8098-480e-9a7b-ff56354563c9

📥 Commits

Reviewing files that changed from the base of the PR and between 067f7af and d6e1552.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Comment thread CONTRIBUTING.md Outdated
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