docs: overhaul README and add contributor/agent guide#57
Open
helios57 wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Documentation-only update that reorganizes repository guidance for end users and contributors by restructuring the README into a task-oriented reference and adding an AGENTS.md contributor/agent guide.
Changes:
- Reworked
README.mdinto clearer sections (overview, how it works, configuration/property reference, API reference, advanced usage, known limitations, build/test guidance). - Added
AGENTS.mddescribing repo structure, coding standards, invariants, and testing expectations for contributors/agents.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Overhauled user-facing documentation, examples, configuration/API reference, and build/testing instructions. |
| AGENTS.md | Added contributor/agent guidance on repo structure, standards, invariants, and testing. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+648
to
+649
| # build without signing artifacts | ||
| mvn -Dgpg.skip verify |
Comment on lines
572
to
+573
| logging: | ||
| pattern: correlation=[${spring.application.name:},%X{traceId:-},%X{spanId:-}] | ||
| pattern: correlation=[${spring.application.name:},%X{traceId:-},%X{spanId:-}] |
GreenRover
approved these changes
Jul 8, 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
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
Documentation-only update: reworks the README into a clear, task-oriented structure and adds an
AGENTS.mdcontributor/agent guide. No code changes.README
RequestReplyService,RequestReplyMessageHeaderSupportService), Advanced usage (variable replacement, custom logging, interceptors, extending to other binders, tracing), Known issues, Building & testing.AGENTS.md (new)
A contributor / AI-agent guide for this repository: technology stack, project structure, coding standards (derived from
.editorconfig), the request/reply model & public API contract, testing, project-specific invariants, and a worked example.Note for maintainers
dedup.maxBitsWhenUnknownis documented as a JVM system property (it is read viaInteger.getInteger(...)), which is how it actually takes effect — the previous README listed it as an application property.