Improve AI agent guidelines: git history review and doc conventions#22263
Open
Improve AI agent guidelines: git history review and doc conventions#22263
Conversation
- Add "Issue Investigation" section requiring agents to check git history, related JIRA tickets, and design docs before implementing fixes - Add "Git History Review" section for PR reviews with same rigor - Add "Documentation Conventions" for adoc files: use xref instead of external URLs, and verify cross-version fragment anchors Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
🌟 Thank you for your contribution to the Apache Camel project! 🌟 🐫 Apache Camel Committers, please review the following items:
|
Contributor
|
ℹ️ CI did not run targeted module tests (all projects built or tests skipped). |
apupier
approved these changes
Mar 25, 2026
Require agents to identify relevant committers using git log/blame on affected files and request reviews when creating PRs. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Require agents to verify external project versions and state via web search rather than relying on potentially stale training data. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
orpiske
approved these changes
Mar 25, 2026
Contributor
orpiske
left a comment
There was a problem hiding this comment.
Nice! I think this is a good improvement. In the future, I think we should also investigate creating some documentation that can be used to fill the context with the right set of information... but that is something to do on a separate occasion.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improve AI agent guidelines based on lessons learned from recent PRs:
.adocfiles: usexref:instead of external URLs, and verify cross-version fragment anchorsgit log/git blameand request reviewsMotivation
Recent PRs highlighted gaps in agent guidelines:
git blamewould have surfaced thiscamel-opentelemetrythat was intentionally omitted fromcamel-opentelemetry2per design doc (proposals/tracing.adoc)xref:from the startClaude Code on behalf of Guillaume Nodet