Skip to content

Add CodeRabbit AI and encourage pre-submission AI reviews #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dealako merged 1 commit into from
Nov 17, 2025
Merged

Add CodeRabbit AI and encourage pre-submission AI reviews #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions ai/git-commits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ For commits where AI provides partial assistance, consider using more specific l
Assisted by [Claude Code](https://claude.ai/code)
Assisted by [Cursor](https://cursor.com)
Reviewed with [GitHub Copilot](https://github.com/features/copilot)
Reviewed with [CodeRabbit AI](https://www.coderabbit.ai)
Copy link

Copilot AI Nov 17, 2025

Choose a reason for hiding this comment

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

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 uses AI. Check for mistakes.
```

## Example Commit Messages
Expand Down Expand Up @@ -282,6 +283,15 @@ echo "AI attribution will now be validated in commits"
- Verify that tests are included for AI-generated functionality
- Check that AI-generated documentation is accurate and complete

> **Note:**
> Developers are strongly encouraged to install and use available AI-powered
> review tools, such as [GitHub Copilot
> Review](https://docs.github.com/en/copilot/copilot-review/about-github-copilot-review)
> and [CodeRabbit AI Review](https://coderabbit.ai/), before submitting pull
Comment on lines +286 to +290
Copy link

Copilot AI Nov 17, 2025

Choose a reason for hiding this comment

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

[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.

Copilot uses AI. Check for mistakes.
> 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.
Comment on lines +291 to +293
Copy link

Copilot AI Nov 17, 2025

Choose a reason for hiding this comment

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

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 uses AI. Check for mistakes.

### Repository Management

- Periodically review commits to track AI tool usage patterns
Expand Down