[ISSUE #4313] : Add AGENTS.md with project structure guidance#4328
Open
elnafateh wants to merge 1 commit into
Open
[ISSUE #4313] : Add AGENTS.md with project structure guidance#4328elnafateh wants to merge 1 commit into
elnafateh wants to merge 1 commit into
Conversation
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.
Describe what this PR does / why we need it
This PR adds a new root-level
AGENTS.mdfile with repository-specific guidance for AI coding assistants working in Spring Cloud Alibaba.This first change is intentionally narrow and only documents project structure and module layout. It gives contributors and AI assistants a verified starting point for navigating the repository before making code changes.
Does this pull request fix one issue?
Fixes #4313
Describe how you did it
Added
AGENTS.mdat the repository root and documented:spring-cloud-alibaba-starters2025.1.xspring-cloud-alibaba-commonsThis PR keeps the scope limited to project structure only and does not add build, JDK, or test workflow guidance yet.
Describe how to verify it
AGENTS.mdfrom the repository root2025.1.xbranch structurespring-cloud-alibaba-starters/Special notes for reviews
This is intended as the first incremental contribution for issue #4313.
I kept the PR to a single new file so the initial review can focus on whether the documented repository structure is accurate before expanding
AGENTS.mdwith additional sections in follow-up PRs.