docs: add claude initial files#46
Conversation
github-actions
Bot
added
the
documentation
|
I have read the CLA Document and I hereby sign the CLA You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot. |
iglin
requested review from
Ksiona,
TaurMorchant,
alsergs,
denisanfimov and
estetsenko
|
|
||
| ## Build & Test | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
Vladimir recommended during the webinar adding -B -ntp -q to mvn commands executed via agents. This significantly reduces log output and saves tokens. It is reasonable to define a separate rule: the first run should use these flags, and if something fails and requires analysis, rerun without the -q flag.
|
|
||
| - Java 21, UTF-8, 2-space indent (enforced by `.editorconfig` present in each module) | ||
| - Lombok: `@Data`, `@Builder`, `@Slf4j` — avoid `@SneakyThrows` | ||
| - No Spring/Quarkus imports in pure-Java core modules (`core-utils`, `core-process-orchestrator`, `maas-client/client`) |
|
|
||
| ## Dependency Management | ||
|
|
||
| - Add any library used by 2+ modules to `core-microservice-dependencies/cloud-core-java-bom/pom.xml` |
There was a problem hiding this comment.
This rule is incorrect. core-microservice-dependencies/cloud-core-java-bom/pom.xml is an external (public) BOM. It does not contain any third-party dependencies. BOMs for such dependencies are currently in progress.
| ## Dependency Management | ||
|
|
||
| - Add any library used by 2+ modules to `core-microservice-dependencies/cloud-core-java-bom/pom.xml` | ||
| - New Quarkus extensions must also be registered in `core-quarkus-extensions/cloud-core-quarkus-bom/pom.xml` |
There was a problem hiding this comment.
This rule is also incorrect. core-quarkus-extensions/cloud-core-quarkus-bom/pom.xml is only an aggregator for several internal BOMs. It does not contain information about Quarkus extensions. Perhaps you meant core-quarkus-extensions/cloud-core-quarkus-bom/cloud-core-quarkus-bom-publish/pom.xml?
|
|
||
| - Add any library used by 2+ modules to `core-microservice-dependencies/cloud-core-java-bom/pom.xml` | ||
| - New Quarkus extensions must also be registered in `core-quarkus-extensions/cloud-core-quarkus-bom/pom.xml` | ||
| - New modules inherit from the nearest `*-parent` POM and import `cloud-core-java-bom` via `<dependencyManagement>` |
There was a problem hiding this comment.
This rule also does not work in the general case.
| ## Architecture Patterns | ||
|
|
||
| - **Spring vs Quarkus**: parallel implementations share a pure-Java core (e.g. `blue-green-state-monitor-java` + Spring module + Quarkus module) | ||
| - **BOM hierarchy**: import `cloud-core-java-bom` in `<dependencyManagement>` before adding deps to any new module |
There was a problem hiding this comment.
This rule is incorrect. This is an external BOM, not an internal one.
| ## Build | ||
|
|
||
| ```bash | ||
| mvn verify # requires Docker (Testcontainers + real Consul) |
There was a problem hiding this comment.
-B -ntp -q — suppress Maven's interactive output, dependency download progress, and INFO logs; keeps only warnings and errors, minimizing token usage for AI agents.
Use everywhere
alsergs
left a comment
alsergs
left a comment
There was a problem hiding this comment.
Better not to have AGENTS.MD at all at the moment.
Looks not helpful for repo maintenance and development
|
5 participants
Claude init files