CAMEL-23823: add AGENTS.md to guide AI agents contributing examples#186
Merged
Conversation
Adds an AGENTS.md with guidance for AI agents working in this repository: the shared Apache Camel rules of engagement (attribution, JIRA ticket ownership, one-example-per-PR, fork-based branches, green CI) plus the specifics of this repo - the Maven module layout and root pom registration, Spring Boot starter usage, @CamelSpringBootTest tests, conventions and a checklist for adding a new example. Complements the canonical apache/camel AGENTS.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
k-krawczyk
force-pushed
the
CAMEL-23823-agents-md
branch
from
866c1a9 to
a72c944
Compare
Croway
approved these changes
Jun 24, 2026
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
2 participants
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.
Description
Resolves part of CAMEL-23823 — add AGENTS.md to examples repos also. The main
apache/camelrepo already ships anAGENTS.md; this adds an equivalent, tailored guide to the examples repositories so AI agents know how to contribute examples here.What it contains
A new top-level
AGENTS.mdwith:AGENTS.md: AI attribution, JIRA ticket ownership (Unassigned only, assign + In Progress), one-example-per-PR / PR volume, fork-based branches named with the JIRA id, green-CI requirement, and human-approval-before-merge.pom.xml, Spring Boot starter usage and BOM-managed versions,@CamelSpringBootTest(camel-test-spring-junit6) tests../mvnwandmvn spring-boot:runcommands; how CI builds and tests on Java 21.camel-example-spring-boot-<name>), Java naming, license headers, README structure.Content was derived by inspecting this repository's current structure, representative example modules, the root/parent
pom.xml, and CI workflows. Happy to adjust tone, depth, or any specifics to match maintainer preference.Reported and implemented by Claude Code on behalf of Karol Krawczyk.
🤖 Generated with Claude Code