Initial round for AGENTS.md

[jabrena]

Summary by CodeRabbit

• Documentation
  • Added a Contributor Quickstart Guide detailing project overview, repository layout, build/test workflow with Maven Wrapper, formatting and testing steps, Java 24 baseline, and commit/PR conventions.
  • Updated the README to clarify the project goal (System prompts for Java Enterprise), broaden tooling guidance beyond a single IDE, recommend current best environments, note regression testing across multiple tools, and expand references (including CLI resources and OpenJDK JEPs).

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Adds a new AGENTS.md contributor quickstart guide and updates README.md to reword goals, broaden tooling guidance, adjust notes/references, and remove the Motivation section. No code or API changes.

Changes

Cohort / File(s)	Summary
Contributor Guide (new) AGENTS.md	Introduces a quickstart guide covering project overview, repo layout, Maven-based build/test/format steps, promotion workflow to cursor/rules, Java 24 baseline, and commit/PR conventions.
README Updates README.md	Removes Motivation section; revises Goal wording; broadens tooling guidance beyond Cursor; adds environment note and references (including agents.md, OpenJDK JEPs, Cursor CLI); keeps regression testing mentions across multiple IDEs/CLIs.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Creating CONTRIBUTING.md #257 — Adds contributor docs for the same generator-driven workflow and promotion steps.
• Patch README.md #259 — Adjusts README environment guidance (IntelliJ, Cursor CLI, Claude Code), overlapping with this PR’s README edits.
• Initial IDEs review #270 — Reframes documentation around System prompts/tooling; related to README and new AGENTS.md positioning.

Poem

In burrows of docs I hop with delight,
New guides sprout fresh in contributor light.
README now speaks of tools far and wide—
I twitch my whiskers with versioned pride.
Tap-tap, mvnw, tests all green—
Promote the rules; the fields stay clean. 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 40352ab and e998de2.

📒 Files selected for processing (2)

• AGENTS.md (1 hunks)
• README.md (2 hunks)

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/agents.md

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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