-
Notifications
You must be signed in to change notification settings - Fork 27
add claude config #346
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
s-yonkov-yonkov
wants to merge
3
commits into
master
Choose a base branch
from
add-claude-config
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
add claude config #346
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| # multiapps — MTA Model Library | ||
|
|
||
| ## Project Role | ||
|
|
||
| This is the **multiapps** repository (`org.cloudfoundry.multiapps`). It is a shared Java | ||
| library providing model objects, YAML parsers, and validators for the SAP Multitarget | ||
| Application (MTA) specification. It serves as a foundational dependency for the | ||
| Cloud Foundry MultiApps Controller. | ||
|
|
||
| ## Security Boundary | ||
|
|
||
| This is an **OPEN SOURCE** repository. Never introduce proprietary logic, credentials, | ||
| or internal company context into this codebase. | ||
|
|
||
| ## Tech Stack | ||
|
|
||
| - **Java 25**, compiled with `maven-compiler-plugin` (source/target 25) | ||
| - **JUnit 5** (`junit-jupiter` 6.x) + **Mockito** for testing | ||
| - **Maven** multi-module build (parent POM: `multiapps-parent`) | ||
|
|
||
| ## Maven Modules | ||
|
|
||
| | Module | Purpose | | ||
| |-------------------------|----------------------------------------------------------------| | ||
| | `multiapps-common` | Shared utilities: YAML handling (SnakeYAML), JSON (Jackson), XML binding (JAXB), commons | | ||
| | `multiapps-common-test` | Shared test utilities and helpers (JUnit/Mockito at compile scope) | | ||
| | `multiapps-mta` | MTA model objects, parsers, and validators (depends on `multiapps-common`) | | ||
| | `multiapps-coverage` | Aggregates JaCoCo coverage reports across all modules (POM-only) | | ||
|
|
||
| ## Build Profiles | ||
|
|
||
| | Profile | Purpose | | ||
| |------------|------------------------------------------------------| | ||
| | `coverage` | Enables JaCoCo agent for code coverage collection | | ||
| | `sonar` | Runs SonarQube analysis (reports to sonarcloud.io) | | ||
| | `release` | Signs artifacts (GPG), attaches sources/javadoc, publishes to Maven Central via Sonatype | | ||
|
|
||
| ## Build & Test Commands | ||
|
|
||
| ```bash | ||
| # Full build with tests | ||
| mvn clean install | ||
|
|
||
| # Run tests only | ||
| mvn test | ||
|
|
||
| # Build, skip tests (for quick local iteration) | ||
| mvn clean install -DskipTests | ||
|
|
||
| # Build a single module (e.g., multiapps-mta) | ||
| mvn clean install -pl multiapps-mta -am | ||
|
|
||
| # Build with coverage | ||
| mvn clean verify -Pcoverage | ||
|
|
||
| # Run SonarQube analysis (requires sonar token) | ||
| mvn clean verify -Pcoverage,sonar | ||
| ``` | ||
|
|
||
| ## Formatting Rule | ||
|
|
||
| Before completing any task or committing code, you **MUST** run: | ||
|
|
||
| ```bash | ||
| mvn spotless:apply | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this and the above mvn commands would probably be the same for all repos using maven - would it not shrink the context to have them in the root md file and keep the local files only for project specific things? |
||
| ``` | ||
|
|
||
| This ensures the codebase follows the standard formatting rules. The Eclipse formatter | ||
| configuration files are located in the `ide/` directory for IDE integration. | ||
|
|
||
| ## Dependency Notes | ||
|
|
||
| - Downstream consumers reference this library via the `multiapps.version` property in | ||
| their POM files (e.g., `multiapps-controller/pom.xml`). | ||
| - When changing public API (model classes, validator interfaces), coordinate updates in | ||
| downstream repos before merging. | ||
| - Build order for cross-repo changes: `multiapps` -> `multiapps-controller`. | ||
|
|
||
| ## Key Libraries | ||
|
|
||
| - **SnakeYAML** — YAML parsing for MTA descriptors | ||
| - **Jackson 3.x** — JSON serialization/deserialization | ||
| - **Immutables** — annotation-processed value objects (provided scope) | ||
| - **Semver4j** — semantic versioning for MTA schema version dispatch | ||
| - **Commons Compress** — archive handling for `.mtar` files | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does this security boundary note need to be doubled here in addition to in the rooot md file? Can it not only have a single source of truth in the root?