Skip to content

Commit d95cfe1

Browse files
committed
Renaming & Updating docs
1 parent c540baa commit d95cfe1

File tree

10 files changed

+18
-18
lines changed

10 files changed

+18
-18
lines changed

.cursor/rules/164-java-profiling-compare.md renamed to .cursor/rules/164-java-profiling-verify.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
author: Juan Antonio Breña Moral
33
version: 0.12.0-SNAPSHOT
44
---
5-
# Java Profiling Workflow / Step 4 / Compare results after refactoring
5+
# Java Profiling Workflow / Step 4 / Verify results
66

77
## Role
88

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
130130
- **Architecture Decision Records (ADRs)**: Added formal documentation for architectural decisions
131131
- ADR-001: Generate cursor rules from XML files
132132
- ADR-002: Configure cursor rules with manual scope
133-
- **Comprehensive User Guide**: Added `CURSOR-RULES-JAVA.md` as a complete reference guide for all cursor rules
133+
- **Comprehensive User Guide**: Added `SYSTEM-PROMPTS-JAVA.md` as a complete reference guide for all cursor rules
134134
- **Build Infrastructure Improvements**:
135135
- JBang script for markdown validation
136136
- GitHub workflow artifact upload for generated cursor rules

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
## Goal
99

1010
The project provides a collection of `System prompts` for Java Enterprise development that help software engineers in their daily programming work and data pipelines.
11-
The [available System prompts for Java](./CURSOR-RULES-JAVA.md) cover aspects like `Build system based on Maven`, `Design`, `Coding`, `Testing`, `Refactoring & JMH Benchmarking`, `Performance testing with JMeter`, `Profiling with Async profiler/OpenJDK tools`, `Documentation` & `Diagrams`.
11+
The [available System prompts for Java](./SYSTEM-PROMPTS-JAVA.md) cover aspects like `Build system based on Maven`, `Design`, `Coding`, `Testing`, `Refactoring & JMH Benchmarking`, `Performance testing with JMeter`, `Profiling with Async profiler/OpenJDK tools`, `Documentation` & `Diagrams`.
1212

1313
### Compatibility with Modern IDEs, CLI & Others
1414

@@ -52,7 +52,7 @@ New to this repository? Start with our [comprehensive guide](./documentation/GET
5252

5353
## How many system prompts for Java does this project include?
5454

55-
Explore the [complete catalog of available System prompts](./CURSOR-RULES-JAVA.md) to discover the full range of capabilities and find the perfect rules for your specific use cases.
55+
Explore the [complete catalog of available System prompts](./SYSTEM-PROMPTS-JAVA.md) to discover the full range of capabilities and find the perfect rules for your specific use cases.
5656

5757
## Constraints, Output format & Safety guards
5858

CURSOR-RULES-JAVA.md renamed to SYSTEM-PROMPTS-JAVA.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Use the following collection of System prompts of Java to improve your Java deve
6363
| [161-java-profiling-detect](.cursor/rules/161-java-profiling-detect.md) | Profile your development in runtime and collect evidences to be analyzed later. | **Prompt:** `My Java application has performance issues - help me set up comprehensive profiling process using @161-java-profiling-detect and use the location YOUR-DEVELOPMENT/profiler` **Note:** Replace YOUR-DEVELOPMENT with your actual development path. Example: examples/spring-boot-memory-leak-demo/profiler | Non conversational cursor rule. The Cursor rule will generate 2 scripts. One script designed to run your development with the right JVM flags for profiling and the second scripts will ask few questions about what problem do you want to solve/analyze over one particular PID. **Step 1:** execute `./run-with-profiler.sh --help` **Step2:** execute `./run-jmeter.sh --help` **Step 3:** execute `./profiler/scripts/java-profile.sh` |
6464
| [162-java-profiling-analyze](.cursor/rules/162-java-profiling-analyze.md) | Analyze results from previous step and generate reports with the analysis results.| **Prompt:** `Analyze the results located in YOUR-DEVELOPMENT/profiler and use the cursor rule @162-java-profiling-analyze` **Note:** Replace YOUR-DEVELOPMENT with your actual development path. Example: examples/spring-boot-memory-leak-demo/profiler | Non conversational cursor rule. |
6565
| - | Code Refactoring from suggestions from analysis | `Can you apply the solutions from @profiling-solutions-yyyymmdd.md in @/info to mitigate bottlenecks` | Make a refactoring with the notes from the analysis |
66-
| [164-java-profiling-compare](.cursor/rules/164-java-profiling-compare.md) | Compare results comparing results before and after applying changes in the code | **Prompt:** `Review if the problems was solved with last refactoring using the reports located in @/results with the cursor rule @164-java-profiling-compare` **Note:** Put in the context the folder with the results | This cursor rule is applied automatically without any interaction with the Software engineer. |
66+
| [164-java-profiling-verify](.cursor/rules/164-java-profiling-verify.md) | Compare results comparing results before and after applying changes in the code | **Prompt:** `Review if the problems was solved with last refactoring using the reports located in @/results with the cursor rule @164-java-profiling-verify` **Note:** Put in the context the folder with the results | This cursor rule is applied automatically without any interaction with the Software engineer. |
6767

6868
## Documentation rules
6969

site-generator/content/blog/2025/09/release-0.10.0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ status=published
99
## What are Cursor rules for Java?
1010
1111
The project provides a collection of System prompts for Java that help software engineers in their daily programming work.
12-
The [available System prompts for Java](https://github.com/jabrena/cursor-rules-java/blob/main/CURSOR-RULES-JAVA.md) cover aspects like `Build system based on Maven`, `Design`, `Coding`, `Testing`, `Refactoring & JMH Benchmarking`, `Performance testing with JMeter`, `Profiling with Async profiler/JDK tools` & `Documentation`.
12+
The [available System prompts for Java](https://github.com/jabrena/cursor-rules-java/blob/main/SYSTEM-PROMPTS-JAVA.md) cover aspects like `Build system based on Maven`, `Design`, `Coding`, `Testing`, `Refactoring & JMH Benchmarking`, `Performance testing with JMeter`, `Profiling with Async profiler/JDK tools` & `Documentation`.
1313
1414
![](/cursor-rules-java/images/workflow.png)
1515
@@ -282,7 +282,7 @@ Add Maven Enforcer plugin only from the rule @112-java-maven-plugins without any
282282
Add tests for the following classes with @131-java-unit-testing
283283
```
284284
285-
Additional examples in the [documentation](https://github.com/jabrena/cursor-rules-java/blob/main/CURSOR-RULES-JAVA.md).
285+
Additional examples in the [documentation](https://github.com/jabrena/cursor-rules-java/blob/main/SYSTEM-PROMPTS-JAVA.md).
286286
287287
### Improve readability in system prompts
288288

site-generator/content/blog/2025/09/release-0.11.0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ status=published
88
99
## What are Cursor rules for Java?
1010
11-
The project provides a collection of System prompts for Java Enterprise development that help software engineers in their daily programming work & data pipelines. The [available System prompts for Java](https://github.com/jabrena/cursor-rules-java/blob/main/CURSOR-RULES-JAVA.md) cover areas such as `Build system based on Maven`, `Design`, `Coding`, `Testing`, `Refactoring & JMH Benchmarking`, `Performance testing with JMeter`, `Profiling with async-profiler/JDK tools`, `Documentation`, and `Diagrams`.
11+
The project provides a collection of System prompts for Java Enterprise development that help software engineers in their daily programming work & data pipelines. The [available System prompts for Java](https://github.com/jabrena/cursor-rules-java/blob/main/SYSTEM-PROMPTS-JAVA.md) cover areas such as `Build system based on Maven`, `Design`, `Coding`, `Testing`, `Refactoring & JMH Benchmarking`, `Performance testing with JMeter`, `Profiling with async-profiler/JDK tools`, `Documentation`, and `Diagrams`.
1212
1313
## What's new in this release?
1414
@@ -71,7 +71,7 @@ Improve the classes provided in the context
7171
by applying the system prompt @128-java-generics
7272
```
7373
74-
Further information: https://github.com/jabrena/cursor-rules-java/blob/0.11.0/CURSOR-RULES-JAVA.md
74+
Further information: https://github.com/jabrena/cursor-rules-java/blob/0.11.0/SYSTEM-PROMPTS-JAVA.md
7575
7676
With this evolution, software engineers now can combine pure system prompts and specialized behaviors in `16^3 = 4096` combinations by design.
7777

system-prompts-generator/src/main/resources/100-java-cursor-rules-list.xml renamed to system-prompts-generator/src/main/resources/100-java-system-prompt-java-list.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44
<metadata>
55
<author>Juan Antonio Breña Moral</author>
66
<version>0.12.0-SNAPSHOT</version>
7-
<title>Create a Checklist with all Java steps to use with cursor rules for Java</title>
7+
<title>Create a Checklist with all Java steps to use with system prompts for Java</title>
88
</metadata>
99

1010
<role>You are a Senior software engineer with extensive experience in Java software development</role>
1111

1212
<goal> Your task is to create a comprehensive step-by-step guide that follows the exact format
1313
and structure defined in the embedded template below. Create a markdown file named
14-
`CURSOR-RULES-JAVA.md` with the following content:
14+
`SYSTEM-PROMPTS-JAVA.md` with the following content:
1515

1616
```markdown
17-
<xi:include href="fragments/java-cursor-rules-list-template.md" parse="text" />
17+
<xi:include href="fragments/java-system-prompt-java-list-template.md" parse="text" />
1818
```
1919
</goal>
2020

@@ -37,10 +37,10 @@
3737
<output-format>
3838
<output-format-list>
3939
<output-format-item>**File Creation**: Generate the complete markdown file named
40-
`CURSOR-RULES-JAVA.md` in the project root directory</output-format-item>
40+
`SYSTEM-PROMPTS-JAVA.md` in the project root directory</output-format-item>
4141
<output-format-item>**Template Adherence**: Follow the embedded template structure and
4242
content exactly - no additions, modifications, or omissions</output-format-item>
43-
<output-format-item>**File Handling**: If `CURSOR-RULES-JAVA.md` already exists,
43+
<output-format-item>**File Handling**: If `SYSTEM-PROMPTS-JAVA.md` already exists,
4444
overwrite it completely with the new generated content</output-format-item>
4545
</output-format-list>
4646
</output-format>

system-prompts-generator/src/main/resources/164-java-profiling-compare.xml renamed to system-prompts-generator/src/main/resources/164-java-profiling-verify.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<metadata>
55
<author>Juan Antonio Breña Moral</author>
66
<version>0.12.0-SNAPSHOT</version>
7-
<title>Java Profiling Workflow / Step 4 / Compare results after refactoring</title>
7+
<title>Java Profiling Workflow / Step 4 / Verify results</title>
88
</metadata>
99

1010
<role>You are a Senior software engineer with extensive experience in Java software development</role>

system-prompts-generator/src/main/resources/fragments/java-cursor-rules-list-template.md renamed to system-prompts-generator/src/main/resources/fragments/java-system-prompts-java-list-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Use the following collection of System prompts of Java to improve your Java deve
6464
| [161-java-profiling-detect](.cursor/rules/161-java-profiling-detect.md) | Profile your development in runtime and collect evidences to be analyzed later. | **Prompt:** `My Java application has performance issues - help me set up comprehensive profiling process using @161-java-profiling-detect and use the location YOUR-DEVELOPMENT/profiler` **Note:** Replace YOUR-DEVELOPMENT with your actual development path. Example: examples/spring-boot-memory-leak-demo/profiler | Non conversational cursor rule. The Cursor rule will generate 2 scripts. One script designed to run your development with the right JVM flags for profiling and the second scripts will ask few questions about what problem do you want to solve/analyze over one particular PID. **Step 1:** execute `./run-with-profiler.sh --help` **Step2:** execute `./run-jmeter.sh --help` **Step 3:** execute `./profiler/scripts/java-profile.sh` |
6565
| [162-java-profiling-analyze](.cursor/rules/162-java-profiling-analyze.md) | Analyze results from previous step and generate reports with the analysis results.| **Prompt:** `Analyze the results located in YOUR-DEVELOPMENT/profiler and use the cursor rule @162-java-profiling-analyze` **Note:** Replace YOUR-DEVELOPMENT with your actual development path. Example: examples/spring-boot-memory-leak-demo/profiler | Non conversational cursor rule. |
6666
| - | Code Refactoring from suggestions from analysis | `Can you apply the solutions from @profiling-solutions-yyyymmdd.md in @/info to mitigate bottlenecks` | Make a refactoring with the notes from the analysis |
67-
| [164-java-profiling-compare](.cursor/rules/164-java-profiling-compare.md) | Compare results comparing results before and after applying changes in the code | **Prompt:** `Review if the problems was solved with last refactoring using the reports located in @/results with the cursor rule @164-java-profiling-compare` **Note:** Put in the context the folder with the results | This cursor rule is applied automatically without any interaction with the Software engineer. |
67+
| [164-java-profiling-verify](.cursor/rules/164-java-profiling-verify.md) | Compare results comparing results before and after applying changes in the code | **Prompt:** `Review if the problems was solved with last refactoring using the reports located in @/results with the cursor rule @164-java-profiling-verify` **Note:** Put in the context the folder with the results | This cursor rule is applied automatically without any interaction with the Software engineer. |
6868

6969
## Documentation rules
7070

system-prompts-generator/src/test/java/info/jab/pml/SystemPromptsInventory.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ private SystemPromptsInventory() {
99

1010
public static final Stream<String> baseNames() {
1111
return Stream.of(
12-
"100-java-cursor-rules-list",
12+
"100-java-system-prompt-java-list",
1313
"110-java-maven-best-practices",
1414
"111-java-maven-dependencies",
1515
"112-java-maven-plugins",
@@ -29,7 +29,7 @@ public static final Stream<String> baseNames() {
2929
"151-java-performance-jmeter",
3030
"161-java-profiling-detect",
3131
"162-java-profiling-analyze",
32-
"164-java-profiling-compare",
32+
"164-java-profiling-verify",
3333
"170-java-documentation",
3434
"171-java-diagrams",
3535
"behaviour-consultative-interaction",

0 commit comments

Comments
 (0)