Add CodeRabbit AI and encourage pre-submission AI reviews

[dealako]

Summary

• Adds CodeRabbit AI to the list of supported AI review tools
• Includes a note encouraging developers to use AI-powered review tools before submitting pull requests
• Promotes proactive code quality improvements through early automated feedback

Changes

• Added CodeRabbit AI to the attribution examples section
• Added a best practices note recommending GitHub Copilot Review and CodeRabbit AI usage prior to PR submission

Test plan

• Documentation is clear and follows existing formatting
• Changes align with repository's AI attribution standards
• Markdown passes validation

🤖 Generated with Claude Code

[coderabbitai]

Walkthrough

Documentation file ai/git-commits.md was updated with additional attribution guidance and encouragement to use AI-powered review tools before submitting pull requests. Two note blocks were added to guide developers on incorporating AI-assisted code review into their workflow.

Changes

Cohort / File(s)	Summary
Documentation Updates ai/git-commits.md	Added "Reviewed with CodeRabbit AI" attribution line to partial attribution example; introduced two note blocks recommending AI review tools (GitHub Copilot Review and CodeRabbit AI Review) in post-attribution guidance and best practices sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• Documentation-only changes with no logic, error handling, or control flow modifications.

Possibly related PRs

• Add AI-assisted git commits documentation #11: Created the initial ai/git-commits.md file with foundational AI attribution guidance.
• Update AI attribution standards and clarify organizational metrics #28: Modified the same file to enhance attribution content and examples related to AI tool usage.
• Add AI agent guidelines and expand AI attribution options #25: Updated ai/git-commits.md with related changes to AI attribution lines and recommended review tools.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main changes: adding CodeRabbit AI and encouraging pre-submission AI reviews, which aligns with the changeset that adds CodeRabbit AI attribution and introduces notes promoting AI-powered review tools.
Description check	✅ Passed	The description is directly related to the changeset, providing clear context about adding CodeRabbit AI support and encouraging pre-submission AI reviews, with specific details about changes and validation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/ai-git-commit-notes

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

• Provide your own instructions using the high_level_summary_instructions setting.
• Format the summary however you like (bullet lists, tables, contributor stats, etc.).
• Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example:

"Create a concise high-level summary as a bullet-point list. Then include a Markdown table showing lines added and removed by each contributing author."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

---

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

[Copilot]

Pull Request Overview

This PR adds CodeRabbit AI to the list of supported AI review tools in the documentation and introduces a best practices note encouraging developers to use AI-powered review tools before submitting pull requests.

• Added CodeRabbit AI as an example attribution line for code reviews
• Introduced a new note promoting proactive use of GitHub Copilot Review and CodeRabbit AI

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The URL format for CodeRabbit AI is inconsistent with the one used in the best practices note below (line 290). Line 90 uses 'https://www.coderabbit.ai' while line 290 uses 'https://coderabbit.ai/'. These should be standardized to use the same URL throughout the document.

Suggested change

	Reviewed with [CodeRabbit AI](https://www.coderabbit.ai)
	Reviewed with [CodeRabbit AI](https://coderabbit.ai/)

[Copilot]

The note mentions 'Running these tools locally' but CodeRabbit AI is a cloud-based service that operates on pull requests in GitHub, not a local tool. This description is inaccurate for CodeRabbit. Consider revising to 'Using these tools provides early automated feedback' or similar wording that doesn't imply local execution for all mentioned tools.

Suggested change

	> requests. Running these tools locally provides early automated feedback on code
	> quality, security, and style—enabling you to address issues proactively prior to
	> sharing your changes with the team for review.
	> requests. Using these tools provides early automated feedback on code quality,
	> security, and style—enabling you to address issues proactively prior to sharing
	> your changes with the team for review.

[Copilot]

[nitpick] The placement of this note under 'Code Review Considerations' may be confusing since it encourages developers to use tools before submitting pull requests, while the section is focused on what reviewers should check. This note would be more appropriately placed under 'Developer Guidelines' (starting at line 273) where other pre-commit guidance is provided.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

ai/git-commits.md (1)

286-293: Simplify "prior to" for conciseness.

Replace "prior to" with "before" on line 292 to improve readability and align with conciseness guidelines.

- sharing your changes with the team for review.
+ sharing your changes with the team for review.

Apply this change:

- quality, security, and style—enabling you to address issues proactively prior to
- sharing your changes with the team for review.
+ quality, security, and style—enabling you to address issues proactively before
+ sharing your changes with the team for review.

The content and placement of this encouragement is solid and effectively communicates the benefit of running AI review tools early in the development workflow.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 082d971 and a26729d.

📒 Files selected for processing (1)

• ai/git-commits.md (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.md

📄 CodeRabbit inference engine (CLAUDE.md)

All Markdown documentation must pass markdownlint validation

**/*.md: Lint Markdown files using markdownlint-cli2 (or via act with .github/workflows/markdown-lint.yml) before committing
Validate documentation by running Markdown lint locally before committing
Use ATX-style headers (# H1, ## H2) in Markdown documents
Indent lists with 2 spaces in Markdown
Keep Markdown line length under 120 characters
Allow headers with the same content at different nesting levels in Markdown
HTML tags are permitted within Markdown documents
Markdown documents do not require a top-level header

Files:

• ai/git-commits.md

🧠 Learnings (1)

📚 Learning: 2025-09-26T01:29:16.465Z

Learnt from: CR
Repo: linuxfoundation/lfx-engineering PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-09-26T01:29:16.465Z
Learning: Include the Jira ticket in commit messages when applicable

Applied to files:

• ai/git-commits.md

🪛 LanguageTool

ai/git-commits.md

[style] ~292-~292: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...bling you to address issues proactively prior to > sharing your changes with the team fo...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Upload results

🔇 Additional comments (1)

ai/git-commits.md (1)

90-90: Well-placed addition to partial attribution examples.

The CodeRabbit AI attribution line follows the established format and integrates cleanly with existing examples.

[prabodhcs]

LGTM