Skip to content

Commit b618d1c

Browse files
jabrenajabrena
authored
Updating README (#503)
1 parent dd1f581 commit b618d1c

1 file changed

Lines changed: 34 additions & 31 deletions

File tree

‎README.md‎

Lines changed: 34 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Cursor AI rules for Java
22

33
## Stargazers over time
4-
[![Stargazers over time](https://starchart.cc/jabrena/cursor-rules-java.svg?variant=light)](https://starchart.cc/jabrena/cursor-rules-java)
54

6-
[![CI Builds](https://github.com/jabrena/cursor-rules-java/actions/workflows/maven.yaml/badge.svg)](https://github.com/jabrena/cursor-rules-java/actions/workflows/maven.yaml)
5+
[Stargazers over time](https://starchart.cc/jabrena/cursor-rules-java)
6+
7+
[CI Builds](https://github.com/jabrena/cursor-rules-java/actions/workflows/maven.yaml)
78

89
## Share your feedback
910

@@ -23,24 +24,26 @@
2324
## Goal
2425

2526
The project provides a curated collection of `System prompts` & `Skills` for Java Enterprise development that help software engineers and pipelines in their daily programming work.
26-
The project covers aspects like `Build system based on Maven`, `Design`, `Coding`, `Testing`, `Refactoring & JMH Benchmarking`, `Performance testing with JMeter`, `Profiling with Async profiler/OpenJDK tools`, `Documentation`, `ADRs`, `Diagrams` & `AGENTS.md`.
27+
The project covers aspects like `Agile tasks for Java projects`, ``, `Build system based on Maven`, `Design`, `Coding`, `Testing`, `Refactoring & JMH Benchmarking`, `Performance testing with JMeter`, `Profiling with Async profiler/OpenJDK tools`, `Documentation`, `ADRs`, `Diagrams` & `AGENTS.md`.
2728

2829
## Deliverables
2930

3031
The project generates a set of deliverables at the end of any iteration.
3132

32-
| Deliverable | Location |
33-
|-------------|----------|
34-
| System prompts for Java | [Catalog](./SYSTEM-PROMPTS-JAVA.md) (`.cursor/rules`) |
35-
| Skills for Java | https://skills.sh/?q=jabrena |
33+
34+
| Deliverable | Location |
35+
| ----------------------- | ------------------------------------------------------------ |
36+
| System prompts for Java | [Catalog](./SYSTEM-PROMPTS-JAVA.md) (`.cursor/rules`) |
37+
| Skills for Java | [https://skills.sh/?q=jabrena](https://skills.sh/?q=jabrena) |
38+
3639

3740
## Getting started
3841

3942
Read the following comprehensive guides to use this project today.
4043

41-
- [Getting started with `System prompts for Java`](./documentation/GETTING-STARTED-SYSTEM-PROMPTS.md)
42-
- [Getting started with `Skills for Java`](./documentation/GETTING-STARTED-SKILLS.md)
43-
- [Getting started with `Pipelines and AI`](./documentation/GETTING-STARTED-PIPELINES.md)
44+
- [Getting started with `System prompts for Java](./documentation/GETTING-STARTED-SYSTEM-PROMPTS.md)`
45+
- [Getting started with `Skills for Java](./documentation/GETTING-STARTED-SKILLS.md)`
46+
- [Getting started with `Pipelines and AI](./documentation/GETTING-STARTED-PIPELINES.md)`
4447

4548
## How to use them?
4649

@@ -50,15 +53,15 @@ The SLDC has evolved with the arrival of this new set of AI tooling, enhancing t
5053

5154
Adding AI tools to the Java development workflow can increase the likelihood of implementing software specifications on time and with quality.
5255

53-
![](./documentation/images/workflow.png)
56+
5457

5558
In this workflow, you could 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
5659

5760
### Pipelines workflow
5861

5962
Adding AI tools to your pipeline can provide new opportunities to deliver more value (examples: automatic coding, code refactoring, continuous profiling, and others).
6063

61-
![](./documentation/images/workflow-pipelines.png)
64+
6265

6366
## Limitations
6467

@@ -86,13 +89,15 @@ The repository includes [a collection of examples](./examples/) where you can ex
8689

8790
## Architectural decision records, ADR
8891

89-
| Date | ID | Name |
90-
|---|---|---|
91-
| 2026-03-01 | ADR-004 | [Skill Generation](./documentation/adr/ADR-004-skill-generation.md) |
92-
| 2025-09-16 | ADR-003 | [Website Generation](./documentation/adr/ADR-003-website-generation.md) |
93-
| 2025-07-10 | ADR-002 | [Cursor Rules scope configuration](./documentation/adr/ADR-002-configure-cursor-rules-manual-scope.md) |
92+
93+
| Date | ID | Name |
94+
| ---------- | ------- | ------------------------------------------------------------------------------------------------------------- |
95+
| 2026-03-01 | ADR-004 | [Skill Generation](./documentation/adr/ADR-004-skill-generation.md) |
96+
| 2025-09-16 | ADR-003 | [Website Generation](./documentation/adr/ADR-003-website-generation.md) |
97+
| 2025-07-10 | ADR-002 | [Cursor Rules scope configuration](./documentation/adr/ADR-002-configure-cursor-rules-manual-scope.md) |
9498
| 2025-07-08 | ADR-001 | [Cursor Rules generation from XML Files](./documentation/adr/ADR-001-generate-cursor-rules-from-xml-files.md) |
9599

100+
96101
## Changelog
97102

98103
- Review the [CHANGELOG](./CHANGELOG.md) for further details
@@ -120,9 +125,9 @@ Java uses JEPs as the vehicle to describe new features to be added to the langua
120125
### Blogs
121126

122127
- [Delegating Java tasks to Supervised AI Dev Pipelines](https://www.javaadvent.com/2025/12/delegating-java-tasks-to-supervised-ai-dev-pipelines.html)
123-
- https://vibekode.it/blog/cursor-ai-developer-cloud-platform/
124-
- https://www.linkedin.com/pulse/september-rest-story-jvm-weekly-vol-146-artur-skowro%C5%84ski-82lif/?trackingId=wbWPSL65TpCCbdg5ksAWjw%3D%3D
125-
- https://virtuslab.com/blog/ai/providing-library-documentation/
128+
- [https://vibekode.it/blog/cursor-ai-developer-cloud-platform/](https://vibekode.it/blog/cursor-ai-developer-cloud-platform/)
129+
- [https://www.linkedin.com/pulse/september-rest-story-jvm-weekly-vol-146-artur-skowro%C5%84ski-82lif/?trackingId=wbWPSL65TpCCbdg5ksAWjw%3D%3D](https://www.linkedin.com/pulse/september-rest-story-jvm-weekly-vol-146-artur-skowro%C5%84ski-82lif/?trackingId=wbWPSL65TpCCbdg5ksAWjw%3D%3D)
130+
- [https://virtuslab.com/blog/ai/providing-library-documentation/](https://virtuslab.com/blog/ai/providing-library-documentation/)
126131

127132
## References
128133

@@ -131,27 +136,25 @@ Java uses JEPs as the vehicle to describe new features to be added to the langua
131136
- [https://cursor.com/cli](https://cursor.com/cli)
132137
- [https://docs.cursor.com/context/rules](https://docs.cursor.com/context/rules)
133138
- [https://docs.cursor.com/context/@-symbols/@-cursor-rules](https://docs.cursor.com/context/@-symbols/@-cursor-rules)
134-
- https://agentskills.io/home
135-
- https://github.com/anthropics/skills
136-
- https://resources.anthropic.com/hubfs/The-Complete-Guide-to-Building-Skill-for-Claude.pdf
137-
- https://skills.sh/
138-
- https://github.com/vercel-labs/skills/issues
139-
- https://skillsmp.com/
140-
- https://cursor.com/docs/cli/github-actions
141-
- https://code.claude.com/docs/en/github-actions
139+
- [https://agentskills.io/home](https://agentskills.io/home)
140+
- [https://github.com/anthropics/skills](https://github.com/anthropics/skills)
141+
- [https://resources.anthropic.com/hubfs/The-Complete-Guide-to-Building-Skill-for-Claude.pdf](https://resources.anthropic.com/hubfs/The-Complete-Guide-to-Building-Skill-for-Claude.pdf)
142+
- [https://skills.sh/](https://skills.sh/)
143+
- [https://github.com/vercel-labs/skills/issues](https://github.com/vercel-labs/skills/issues)
144+
- [https://skillsmp.com/](https://skillsmp.com/)
145+
- [https://cursor.com/docs/cli/github-actions](https://cursor.com/docs/cli/github-actions)
146+
- [https://code.claude.com/docs/en/github-actions](https://code.claude.com/docs/en/github-actions)
142147
- [https://www.anthropic.com/claude-code](https://www.anthropic.com/claude-code)
143148
- [https://github.com/features/copilot](https://github.com/features/copilot)
144149
- [https://www.jetbrains.com/junie/](https://www.jetbrains.com/junie/)
145150
- [https://openjdk.org/jeps/0](https://openjdk.org/jeps/0)
146-
- https://jbake.org/docs/latest/
151+
- [https://jbake.org/docs/latest/](https://jbake.org/docs/latest/)
147152

148153
## Cursor rules ecosystem
149154

150155
- [https://github.com/jabrena/101-cursor](https://github.com/jabrena/101-cursor)
151156
- [https://github.com/jabrena/pml](https://github.com/jabrena/pml)
152-
- [https://github.com/jabrena/cursor-rules-agile](https://github.com/jabrena/cursor-rules-agile)
153157
- [https://github.com/jabrena/cursor-rules-java](https://github.com/jabrena/cursor-rules-java)
154-
- [https://github.com/jabrena/cursor-rules-spring-boot](https://github.com/jabrena/cursor-rules-spring-boot)
155158
- [https://github.com/jabrena/cursor-rules-examples](https://github.com/jabrena/cursor-rules-examples)
156159
- [https://github.com/jabrena/plantuml-to-png-cli](https://github.com/jabrena/plantuml-to-png-cli)
157160
- [https://github.com/jabrena/setup-cli](https://github.com/jabrena/setup-cli)

0 commit comments

Comments
 (0)