Skip to content

Commit cddf9e9

Browse files
authored
docs(article): Adding article (#653)
* docs(article): Adding article * build(pom): align root description with Skills and Agents Made-with: Cursor
1 parent 9308e91 commit cddf9e9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+863
-489
lines changed

.github/workflows/maven.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,27 @@ jobs:
7272
java-version: '25'
7373
- name: Build ${{ matrix.example.name }}
7474
run: cd ${{ matrix.example.path }} && ./mvnw --batch-mode --no-transfer-progress ${{ matrix.example.goal }} --file pom.xml
75+
76+
package-agent-artifacts:
77+
name: Package Agents and Skills
78+
runs-on: ubuntu-latest
79+
steps:
80+
- uses: actions/checkout@v6
81+
with:
82+
submodules: true
83+
- name: Create agents archive
84+
run: cd .cursor && zip -r ../agents.zip agents
85+
- name: Create skills archive
86+
run: zip -r skills.zip skills
87+
- name: Upload agents.zip
88+
uses: actions/upload-artifact@v4
89+
with:
90+
name: agents.zip
91+
path: agents.zip
92+
if-no-files-found: error
93+
- name: Upload skills.zip
94+
uses: actions/upload-artifact@v4
95+
with:
96+
name: skills.zip
97+
path: skills.zip
98+
if-no-files-found: error

CHANGELOG.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1616
- Add INVEST validation to agile user-story workflow in `@014-agile-user-story` (#633)
1717
- Maven Central search guidance skill (`@114-java-maven-search`) (#605)
1818
- OpenSpec adoption for project change management in `@042-planning-openspec` (#620, #621, #616)
19-
- GitHub issue management workflow support`@043-planning-github` (#607)
19+
- GitHub issue management workflow support (`@043-planning-github-issues`) (#607)
2020
- Jira planning support and guidance improvements in `@044-planning-jira` (#631, #641, #642)
2121
- OpenAPI guidance skill `@701-technologies-openapi` (#635)
2222
- WireMock guidance skill `@702-technologies-wiremock` (#636)
2323
- Fuzz testing skill `@703-technologies-fuzzing-testing` and CATS example coverage (#634, #646)
2424
- Cursor and Claude plugin support documentation/workflow (#622)
2525

2626
- **Rules:**
27-
- Created an ADR to drop support for Rules in favor of Skills.
27+
- Added an ADR documenting the decision to drop Rules in favor of Skills.
2828

2929
- **Examples:**
30-
- Reduce CI Pipeline times, removing non essential examples
30+
- Reduced CI pipeline duration by removing non-essential examples
3131

3232
## [0.13.0] 2026-03-30
3333

@@ -71,12 +71,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7171

7272
- **Skills & Agent system**:
7373
- SKILL generator for Cursor agent skills (#421).
74-
- Skills support evolution (v1–v4) with skilljars and validation pipeline (#416, #418, #420, #423, #424).
74+
- Skills support evolution (v1–v4) with Skill JARs and a validation pipeline (#416, #418, #420, #423, #424).
7575
- Improved skill generation and minimum requirements (#417, #427, #451).
7676

7777
- **New Cursor Rules**:
7878
- `@132-java-testing-integration-testing` with WireMock support (#443).
79-
- Arch Unit support in `@111-java-maven-dependencies` (#445).
79+
- ArchUnit support in `@111-java-maven-dependencies` (#445).
8080

8181
- **Maven rules & docs**:
8282
- Centralized version management and best practices for multi-module POM in `@110-java-maven-best-practices` (#441).
@@ -98,11 +98,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
9898
### Added
9999

100100
- **Behaviours**:
101-
- Added Tone variations to consultative and progressive learning behaviours (#330).
102-
- Added Tone to Interactive prompts
101+
- Added tone variations to consultative and progressive learning behaviours (#330).
102+
- Added tone support for interactive prompts.
103103

104104
- **Website**:
105-
- Added Website to communicate about System prompts for Java. https://jabrena.github.io/cursor-rules-java/
105+
- Added a website covering system prompts for Java: https://jabrena.github.io/cursor-rules-java/
106106

107107
- **Educational content**:
108108
- New "System Prompts for Java" course (#335). https://jabrena.github.io/cursor-rules-java/courses/system-prompts-java/index.html
@@ -121,8 +121,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
121121
- **Cursor rules**:
122122
- Extensive refinements across multiple rules (dependencies, plugins, secure coding, concurrency, exception handling, functional programming, documentation, diagrams) (#309, #341).
123123
- Decoupled system prompts from behaviours and added learning behaviour; reorganized generator templates and inventory (#309).
124-
- All examples use single imports without using wildcard *
125-
- Updated profiling Script to add support for Async-profiler 4.1 https://github.com/async-profiler/async-profiler/releases/tag/v4.1
124+
- All examples use single-type imports (no wildcard `import ...*`)
125+
- Updated profiling script to add support for Async-profiler 4.1: https://github.com/async-profiler/async-profiler/releases/tag/v4.1
126126
- Improved JFR support
127127

128128
### Removed
@@ -143,7 +143,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
143143
- JMH (Java Microbenchmark Harness) support for Maven projects without modules
144144
- Enhanced Maven plugins cursor rule with comprehensive JMH integration
145145

146-
- Tested the project for Cursor, Cursor CLI, Claude Code, GitHub Copilot & JetBrains Junie. Further information at https://github.com/jabrena/cursor-rules-java/blob/main/docs/reviews/review-20250829.md
146+
- Tested the project for Cursor, Cursor CLI, Claude Code, GitHub Copilot, and JetBrains Junie. Further information: https://github.com/jabrena/cursor-rules-java/blob/main/docs/reviews/review-20250829.md
147147

148148
### Changed
149149

@@ -289,7 +289,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
289289
- `@304-java-rest-api-design` (moved to separate Spring Boot rules project)
290290
- `@500-sql` (moved to Spring Boot rules)
291291

292-
## [0.6.0] 30/5/2025
292+
## [0.6.0] 2025-05-30
293293

294294
### Added
295295

@@ -301,7 +301,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
301301
- Moved the Cursor rule about acceptance criteria as part of the repository about [Agile](https://github.com/jabrena/cursor-rules-agile)
302302
- Increased consistency in all cursor rules, now all examples use asserts from AssertJ
303303

304-
## [0.5.0] 20/05/2025
304+
## [0.5.0] 2025-05-20
305305

306306
### Added
307307

@@ -313,7 +313,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
313313

314314
- Updated all cursor rules
315315

316-
## [0.4.0] 27/04/2025
316+
## [0.4.0] 2025-04-27
317317

318318
### Added
319319

@@ -323,7 +323,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
323323

324324
- Updated all cursor rules
325325

326-
## [0.3.0] 06/04/2025
326+
## [0.3.0] 2025-04-06
327327

328328
### Added
329329

@@ -334,7 +334,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
334334
- Updated cursor rules (Java, Effective Java, Concurrency, Functional programming, Data-Oriented programming, Pragmatic Unit Testing, Spring Boot & Quarkus)
335335

336336

337-
## [0.2.0] 01/03/2025
337+
## [0.2.0] 2025-03-01
338338

339339
### Added
340340

@@ -344,7 +344,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
344344

345345
- Updated cursor rules (Java, Effective Java, Concurrency, Functional programming, Data-Oriented programming & Spring Boot)
346346

347-
## [0.1.0] 09/02/2025
347+
## [0.1.0] 2025-02-09
348348

349349
### Added
350350

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88

99
## Goal
1010

11-
A curated collection of `Skills` and `Agents` for Java Enterprise development, designed to streamline modern `SDLC` workflows.
11+
A curated collection of `Skills` and `Agents` to be used in modern `SDLC` workflows for Java Enterprise development.
1212

1313
| QUESTION | ROLE | AREA | SUPPORT |
1414
| ---------- | ------------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15-
| WHAT / WHEN | PO, BA, EA, SA, TL | Agile & Planning | `User Stories`, `Github Issues` & `Jira`|
15+
| WHAT / WHEN | PO, BA, EA, SA, TL | Agile & Planning | `User Stories`, `GitHub Issues` & `Jira` |
1616
| WHY | EA, SL, TL | Architecture | `ADRs` & `UML` / `C4` / `ER` Diagrams |
1717
| HOW | SA, TL, SWE | Spec-Driven | `AI Plan mode` & `OpenSpec` |
1818
| HOW | TL, SWE | Java development | `Build system based on Maven`, `Design`, `Coding`, `Testing`, `Observability`, `Refactoring & JMH Benchmarking`, `Performance testing with JMeter`, `Profiling with Async profiler/OpenJDK tools`, `Documentation`, `Spring Boot`, `Quarkus`, `Micronaut`, `OpenAPI`, `Wiremock` & `AGENTS.md` |
@@ -22,30 +22,30 @@ A curated collection of `Skills` and `Agents` for Java Enterprise development, d
2222
The project generates a set of deliverables at the end of any iteration.
2323

2424

25-
| Deliverable | Instalation | Getting Started |
25+
| Deliverable | Installation | Getting Started |
2626
| --------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
2727
| 1. [Skills for Java](./documentation/INVENTORY-SKILLS-JAVA.md) | `npx skills add jabrena/cursor-rules-java --all --agent cursor` | [`Skills for Java`](./documentation/GETTING-STARTED-SKILLS.md) |
2828
| 2. [Agents for Java](./documentation/INVENTORY-AGENTS-JAVA.md) | `@003-agents-installation` Install Agents in Cursor | [`Agents for Java`](./documentation/GETTING-STARTED-AGENTS.md) |
2929

30-
**Note:** Once you install all skills, you could install the agents easily for Cursor or Claude.
30+
**Note:** After you install the skills, you can install the agents easily for Cursor or Claude.
3131

3232
### Compatibility
3333

34-
This project is compatible with any Tool compatible with `Skills`, `Agents`, `AGENTS.md` & `MCP` Servers.
34+
This project is compatible with any tool that supports `Skills`, `Agents`, `AGENTS.md`, and `MCP` servers.
3535

36-
## How to use them?
36+
## How to use them
3737

38-
The SDLC has evolved with the arrival of this new set of AI tooling, enhancing the Software Engineering process. In the development of this project, it was identified 3 different workflows: `Prompting Enginering Workflow`, `Pipelines Workflow` & `Agentic Workflow`.
38+
The SDLC has evolved with this new wave of AI tooling, which enhances the software engineering process. While building this project, we identified three workflows: `Prompting Engineering Workflow`, `Pipelines Workflow`, and `Agentic Workflow`.
3939

40-
### Prompting Enginering Workflow
40+
### Prompting Engineering Workflow
4141

42-
In this workflow, the Software engineer interact with models using `User prompts` and in an incremental way you delegate a delegate completely a task or ask help in certain moments. You could use this project to refactor the code generated or delegate the task and associate a System prompt / Skills to that task.
42+
In this workflow, the software engineer interacts with models using `User prompts`. In an incremental way, you delegate a whole task or ask for help at specific points. You can use this project to refactor generated code, or delegate the task and attach a system prompt or Skills to it.
4343

4444
![](./documentation/images/workflow-prompts.png)
4545

46-
### Agent Workflow
46+
### Agentic Workflow
4747

48-
`Agents for Java Enterprise development` were designed to help the Software engineer in the implementation phase. The software engineer define good `Specs` and that Specifications are delegated to Agents.
48+
`Agents for Java Enterprise development` were designed to help the software engineer in the implementation phase. The engineer defines solid `Specs`, and those specifications are delegated to Agents.
4949

5050
![](./documentation/images/workflow-agents.png)
5151

@@ -55,29 +55,29 @@ Adding AI tools to your pipeline can provide new opportunities to deliver more v
5555

5656
![](./documentation/images/workflow-pipelines.png)
5757

58-
Futher information [here`](./documentation/GETTING-STARTED-PIPELINES.md)
58+
Further information [here](./documentation/GETTING-STARTED-PIPELINES.md).
5959

6060
## Limitations
6161

6262
### Lack of determinism
6363

64-
From the outset, be aware that the results provided by interactions with the different `Cursor rules` are not deterministic due to the nature of the models, but this can be mitigated with clear goals and validation checkpoints.
64+
From the outset, be aware that results from interactions with these `Skills` and agents are not deterministic because of how the models behave, but you can mitigate that with clear goals and validation checkpoints.
6565

6666
### Not all models behave in the same way
6767

68-
In the project exist some Interactive skills which require to use `Premium` models to run in an interactive way in other case, they will work like in sequence of steps.
68+
Some interactive skills require `Premium` models for interactive use; otherwise they follow a fixed sequence of steps.
6969

7070
### Limits of interactions with models
7171

72-
Models are able to generate code, but they cannot run code with your local data. To address this limitation, some prompts provide scripts to bridge this gap on the model side.
72+
Models can generate code, but they cannot execute it against your local data. To bridge that gap, some Skills include scripts you run locally.
7373

7474
## Contribute
7575

7676
See [CONTRIBUTING.md](./CONTRIBUTING.md) for conventions, generator workflows, tests, and how to open a pull request.
7777

7878
## Examples
7979

80-
The repository includes [a collection of examples](./examples/) where you can explore the possibilities of these system prompts designed for Java.
80+
The repository includes [a collection of examples](./examples/) where you can explore what these Skills and workflows enable for Java.
8181

8282
## Architectural decision records, ADR
8383

@@ -87,11 +87,11 @@ The repository includes [a collection of examples](./examples/) where you can ex
8787

8888
- Review the [CHANGELOG](./CHANGELOG.md) for further details
8989

90-
## Java JEPS from Java 8
90+
## Java JEPs from Java 8 onward
9191

92-
Java uses JEPs as the vehicle to describe new features to be added to the language. The repository continuously reviews which JEPs could improve any of the cursor rules present in this repository.
92+
Java uses JEPs (JDK Enhancement Proposals) to describe new language and platform features. This repository tracks which JEPs could improve the Skills and guidance here.
9393

94-
- [JEPS List](./documentation/jeps/All-JEPS.md)
94+
- [JEPs list](./documentation/jeps/All-JEPS.md)
9595

9696
## Meetups, Conferences, Workshops & Articles
9797

docs/2/index.html

Lines changed: 38 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
<meta charset="utf-8" />
66
<meta http-equiv="X-UA-Compatible" content="IE=edge">
77
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">
8-
<title>Rules, Skills & Agents for Java</title>
8+
<title>Skills & Agents for Java</title>
99
<meta name="author" content="" />
1010
<meta name="description" content="">
11-
<link rel="alternate" type="application/atom+xml" href="../feed.xml" title="Rules, Skills & Agents for Java"/>
11+
<link rel="alternate" type="application/atom+xml" href="../feed.xml" title="Skills & Agents for Java"/>
1212

1313
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css" />
1414
<link rel="stylesheet" href="../css/bootstrap.min.css">
@@ -35,7 +35,7 @@
3535
<span class="icon-bar"></span>
3636
<span class="icon-bar"></span>
3737
</button>
38-
<a class="navbar-brand" href="../index.html">Rules, Skills & Agents for Java</a>
38+
<a class="navbar-brand" href="../index.html">Skills & Agents for Java</a>
3939
</div>
4040

4141
<div class="collapse navbar-collapse" id="main-navbar">
@@ -77,9 +77,9 @@
7777
<div class="row">
7878
<div class="col-lg-8 col-lg-offset-2 col-md-10 col-md-offset-1">
7979
<div class="page-heading">
80-
<h1>Rules, Skills & Agents for Java</h1>
80+
<h1>Skills & Agents for Java</h1>
8181
<hr class="small">
82-
<span class="page-subheading">A curated collection of Rules, Skills, and Agents for Java Enterprise development, designed to streamline modern SDLC workflows.</span>
82+
<span class="page-subheading">A curated collection of Skills and Agents for Java Enterprise development, designed to streamline modern SDLC workflows.</span>
8383
</div>
8484
</div>
8585
</div>
@@ -92,9 +92,9 @@ <h1>Rules, Skills & Agents for Java</h1>
9292
<div class="row">
9393
<div class="col-lg-8 col-lg-offset-2 col-md-10 col-md-offset-1">
9494
<div class="page-heading">
95-
<h1>Rules, Skills & Agents for Java</h1>
95+
<h1>Skills & Agents for Java</h1>
9696
<hr class="small">
97-
<span class="page-subheading">A curated collection of Rules, Skills, and Agents for Java Enterprise development, designed to streamline modern SDLC workflows.</span>
97+
<span class="page-subheading">A curated collection of Skills and Agents for Java Enterprise development, designed to streamline modern SDLC workflows.</span>
9898
</div>
9999
</div>
100100
</div>
@@ -114,6 +114,37 @@ <h1>Rules, Skills & Agents for Java</h1>
114114
<div class="posts-section">
115115
<h2 class="section-title"><i class="fa fa-rss"></i> Latest Posts</h2>
116116
<article class="post-preview">
117+
<h3 class="post-title"><a href="../blog/2025/09/jfr-modern-java-profiling.html">Beyond Traditional Profiling: Mastering JFR for Modern Java Applications</a></h3>
118+
119+
<p class="post-meta">
120+
<i class="fa fa-calendar-o"></i>
121+
2025-09-17
122+
&nbsp;
123+
<i class="fa fa-pencil"></i>
124+
MyRobot
125+
<span class="blog-tags">
126+
&nbsp;
127+
<i class="fa fa-tags"></i>
128+
<a href="../tags/blog.html">blog</a>
129+
<a href="../tags/profiling.html">profiling</a>
130+
<a href="../tags/jfr.html">jfr</a>
131+
<a href="../tags/java.html">java</a>
132+
<a href="../tags/performance.html">performance</a>
133+
<a href="../tags/java-25.html">java-25</a>
134+
</span>
135+
</p>
136+
137+
<div class="post-entry-container">
138+
<div class="post-entry">
139+
Discovering JFR: A Journey into Modern Java Profiling Excellence
140+
Symptom: memory usage drifts under real production load. Constraint: profiling cannot degrade latency or throughput. Solution: Java Flight Recorder (JFR) — the built‑in, low‑overhead recorder that captures CPU, memory, GC, I/O, and custom events from live systems with typically under 2% impact.
141+
With JFR, production evidence replaces g...
142+
<p></p>
143+
<a href="../blog/2025/09/jfr-modern-java-profiling.html" class="post-read-more">[Read More]</a>
144+
</div>
145+
</div>
146+
</article>
147+
<article class="post-preview">
117148
<h3 class="post-title"><a href="../blog/2025/09/release-0.10.0.html">What&apos;s new in Cursor rules for Java 0.10.0?</a></h3>
118149

119150
<p class="post-meta">

docs/about.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
<meta charset="utf-8" />
66
<meta http-equiv="X-UA-Compatible" content="IE=edge">
77
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">
8-
<title>About - Rules, Skills & Agents for Java</title>
8+
<title>About - Skills & Agents for Java</title>
99
<meta name="author" content="" />
1010
<meta name="description" content="">
11-
<link rel="alternate" type="application/atom+xml" href="feed.xml" title="Rules, Skills & Agents for Java"/>
11+
<link rel="alternate" type="application/atom+xml" href="feed.xml" title="Skills & Agents for Java"/>
1212

1313
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css" />
1414
<link rel="stylesheet" href="css/bootstrap.min.css">
@@ -34,7 +34,7 @@
3434
<span class="icon-bar"></span>
3535
<span class="icon-bar"></span>
3636
</button>
37-
<a class="navbar-brand" href="index.html">Rules, Skills & Agents for Java</a>
37+
<a class="navbar-brand" href="index.html">Skills & Agents for Java</a>
3838
</div>
3939

4040
<div class="collapse navbar-collapse" id="main-navbar">

0 commit comments

Comments
 (0)