Skip to main content

113-java-maven-documentation

Use when you need to create a DEVELOPER.md file for a Maven project — combining a fixed base template with dynamic sections derived from the project pom.xml, including a Plugin Goals Reference, Maven Profiles table, and Submodules table for multi-module projects. This should trigger for requests such as Create DEVELOPER.md; Generate DEVELOPER.md; Maven project documentation; Add Maven documentation; Plugin goals reference. Part of cursor-rules-java project

Source facts

Repository
jabrena/cursor-rules-java
Last source activity
June 15, 2026 at 16:07
Detected SKILL.md language
English
Stars
407
Forks
81

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

File Explorer
2 files

Showing SKILL.md

SKILL.md
Source instructions · Read-only preview
name
113-java-maven-documentation
description
Use when you need to create a DEVELOPER.md file for a Maven project — combining a fixed base template with dynamic sections derived from the project pom.xml, including a Plugin Goals Reference, Maven Profiles table, and Submodules table for multi-module projects. This should trigger for requests such as Create DEVELOPER.md; Generate DEVELOPER.md; Maven project documentation; Add Maven documentation; Plugin goals reference. Part of cursor-rules-java project
license
Apache-2.0
metadata
{"author":"Juan Antonio Breña Moral","version":"0.16.0"}
# Create 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`. **What is covered in this Skill?** - 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 - Submodules table (multi-module projects only) ## Constraints Before generating any content, read every pom.xml in the workspace. Only include plugins explicitly declared in the project POMs — never plugins inherited from parent POMs or the Maven super-POM unless redeclared. - **MANDATORY**: Read every `pom.xml` in the workspace (root and submodules) before generating any content - **PLUGIN SCOPE**: 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 - **SCOPE**: Execute steps 1–5 in order. Omit Profiles section if no profiles; omit Submodules section if not multi-module - **BEFORE APPLYING**: Read the reference for the base template content, plugin catalog, and detailed constraints for each step ## When to use this skill - Create DEVELOPER.md - Generate DEVELOPER.md - Maven project documentation - Add Maven documentation - Plugin goals reference - Maven Profiles table - Submodules table ## Workflow 1. **Read all POM files in workspace** Read root and every submodule `pom.xml` before generating content. 2. **Read documentation reference assets** Read `references/113-java-maven-documentation.md` to use the base template and plugin catalog constraints exactly. 3. **Assemble DEVELOPER.md base and dynamic sections** Generate `DEVELOPER.md` with verbatim base template plus dynamic sections: plugin goals, profiles (if any), and submodules (if multi-module). 4. **Enforce plugin scope and section omission rules** Include only explicitly declared plugins and omit Profiles/Submodules sections when not applicable. ## Reference For detailed guidance, examples, and constraints, see [references/113-java-maven-documentation.md](references/113-java-maven-documentation.md).
View on GitHub