113-java-maven-documentation
npx machina-cli add skill jabrena/cursor-rules-java/113-java-maven-documentation --openclawCreate DEVELOPER.md for the Maven projects
Generate a DEVELOPER.md file that combines a fixed base template with dynamic sections derived from analysing the project pom.xml.
Core areas: Base template reproduction (verbatim), plugin goals reference (table of ./mvnw goals per explicitly declared plugin, max 8 goals each), Maven Profiles table (profile ID, activation trigger, representative command, description), and Submodules table (multi-module projects only).
Prerequisites: Read every pom.xml in the workspace (root and submodules) before generating any content. Only include plugins explicitly declared in <build><plugins> or <build><pluginManagement><plugins> — never plugins inherited from parent POMs or the Maven super-POM unless redeclared.
Multi-step scope: Step 1 reproduces the base template verbatim. Step 2 collects all explicitly declared plugins. Step 3 appends the Plugin Goals Reference section. Step 4 appends the Maven Profiles section (omit if no profiles). Step 5 appends the Submodules section (omit if not a multi-module project).
Before applying changes: Read the reference for the base template content, plugin catalog, and detailed constraints for each step.
Reference
For detailed guidance, examples, and constraints, see references/113-java-maven-documentation.md.
Source
git clone https://github.com/jabrena/cursor-rules-java/blob/main/skills/113-java-maven-documentation/SKILL.mdView on GitHub Overview
This skill generates a DEVELOPER.md for a Maven project by blending a fixed base template with live data from the project pom.xml. It builds a Plugin Goals Reference from explicitly declared plugins, adds a Maven Profiles table, and appends a Submodules table for multi-module projects. Prerequisites require scanning all pom.xml files before content generation.
How This Skill Works
Step 1 reproduces the base template verbatim. Step 2 discovers explicitly declared plugins in build/plugins and build/pluginManagement/plugins (excluding inherited ones). Step 3 appends the Plugin Goals Reference (up to 8 goals per plugin), Step 4 adds the Maven Profiles table if profiles exist, and Step 5 adds the Submodules table for multi-module projects.
When to Use It
- You need a standardized DEVELOPER.md for a new Maven project.
- You want to document explicit plugins and their goals for a repo.
- You maintain a multi-module Maven project and need a Submodules table.
- You need to reflect changes in pom.xml in the documentation after updates.
- Onboarding new developers who require a single-source project overview.
Quick Start
- Step 1: Read all pom.xml files in the workspace and prepare the fixed base template content.
- Step 2: Collect explicitly declared plugins from build/plugins and build/pluginManagement/plugins.
- Step 3: Append Plugin Goals Reference, Maven Profiles, and Submodules (if applicable) to complete DEVELOPER.md.
Best Practices
- Read every pom.xml in the workspace (root and submodules) before generating content.
- Include only plugins explicitly declared in build/plugins or build/pluginManagement/plugins.
- Limit the Plugin Goals Reference to a maximum of 8 goals per plugin for readability.
- Keep the base template verbatim and append dynamic sections without altering the template.
- Verify the generated DEVELOPER.md against the current pom.xml to ensure accuracy.
Example Use Cases
- A single-module project: base template plus Plugin Goals Reference for the declared plugins and a Profile table if profiles exist.
- A multi-module project: adds a Submodules table showing each module path and role.
- Project with pluginManagement usage: documents plugin goals sourced from pluginManagement while excluding inherited plugins.
- CI-friendly workflow: generate DEVELOPER.md as part of the release process to capture latest pom.xml data.
- New team onboarding: developers access a single, up-to-date DEVELOPER.md that explains plugins, profiles, and modules.
