Skip to content

docs: add repository guidelines#5538

Merged
nobodyiam merged 4 commits intoapolloconfig:masterfrom
nobodyiam:docs/agents-guidelines
Feb 3, 2026
Merged

docs: add repository guidelines#5538
nobodyiam merged 4 commits intoapolloconfig:masterfrom
nobodyiam:docs/agents-guidelines

Conversation

@nobodyiam
Copy link
Copy Markdown
Member

@nobodyiam nobodyiam commented Feb 3, 2026 •
edited by coderabbitai bot
Loading

What's the purpose of this PR

Add a concise AGENTS.md contributor guide for this repository.

Which issue(s) this PR fixes:

Fixes #

Brief changelog

  • add AGENTS.md with repo guidelines
  • document PR target/template usage

Follow this checklist to help us incorporate your contribution quickly and easily:

  • Read the Contributing Guide before making this pull request.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Write necessary unit tests to verify the code.
  • Run mvn clean test to make sure this pull request doesn't break anything.
  • Run mvn spotless:apply to format your code.
  • Update the CHANGES log.

Summary by CodeRabbit

  • Documentation
    • Added a repository guidance document that explains project layout (including multi-module structure), build/test/development commands, scripts, coding style and naming conventions, testing guidelines, commit and PR workflows, and security/configuration considerations to help contributors navigate and follow project processes.

@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Feb 3, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Feb 3, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

A new documentation file, AGENTS.md, was added providing repository guidance on project layout, build/test workflows, coding standards, testing conventions, commit/PR practices, and security/configuration notes for contributors.

Changes

Cohort / File(s) Summary
Project Documentation
AGENTS.md		 Added a comprehensive guidance document covering repository structure, multi-module Maven build/test/development commands, coding style and naming conventions, testing guidelines (JUnit 5), commit & PR process, and security/configuration notes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 A guide appeared with steady cheer,
Maps of modules, tests made clear,
Commits in line, the rules in sight,
Contributors leap by candlelight,
Hops of code, a tidy flight.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title 'docs: add repository guidelines' accurately summarizes the main change—adding a new AGENTS.md documentation file with repository guidelines.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

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

coderabbitai[bot]
coderabbitai bot reviewed Feb 3, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents 
In `@AGENTS.md`:
- Around line 3-8: The service module list omits apollo-biz; update the "Project
Structure & Module Organization" section to either add apollo-biz alongside
apollo-configservice, apollo-adminservice, and apollo-portal or make the
sentence explicit that the listed modules are examples (e.g., "service modules
like apollo-configservice, apollo-adminservice, apollo-portal, and apollo-biz"
or "examples include..."). Edit the sentence that currently lists
apollo-configservice/apollo-adminservice/apollo-portal to include apollo-biz (or
append a clarifying "partial list" note) so the documentation matches the root
pom's modules.

Comment thread AGENTS.md
@nobodyiam
Copy link
Copy Markdown
Member Author

nobodyiam commented Feb 3, 2026

Thanks! Confirmed apollo-biz is a shared business-logic module (not a standalone service). Updated AGENTS.md to keep service examples to config/admin/portal and explicitly note apollo-biz’s dependency role.

@nobodyiam nobodyiam merged commit e5f6378 into apolloconfig:master Feb 3, 2026
9 checks passed
@nobodyiam nobodyiam deleted the docs/agents-guidelines branch February 3, 2026 05:43
@github-actions github-actions bot locked and limited conversation to collaborators Feb 3, 2026
@nobodyiam nobodyiam added this to the 2.5.0 milestone Feb 19, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

2.5.0

Development

Successfully merging this pull request may close these issues.

1 participant

@nobodyiam