You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .cursor/rules/templates/java-checklist-template.md
+19-21Lines changed: 19 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,56 +8,54 @@ Use the following process to improve the java development in some areas if requi
8
8
9
9
| Cursor Rule | Description | Prompt | Notes |
10
10
|-------------|-------------|--------|-------|
11
-
|[110-java-maven-best-practices](.cursor/rules/110-java-maven-best-practices.mdc)| Maven Best Practices|`Help me to review the pom.xml following the best practices for dependency management and directory structure use the cursor rule @110-java-maven-best-practices`| Add in the context the `pom.xml` which you want to generate the documentation |
12
-
|[111-java-maven-deps-and-plugins](.cursor/rules/111-java-maven-deps-and-plugins.mdc)| Maven Dependencies & Plugins |`Can you improve the pom.xml using the cursor rule @111-java-maven-deps-and-plugins`| Add in the context the `pom.xml` which you want to generate the documentation. Conversational approach |
13
-
|[112-java-maven-documentation](.cursor/rules/112-java-maven-documentation.mdc)| Maven Documentation |`Generate developer documentation with essential Maven commands using @112-java-maven-documentation`| Add in the context the `pom.xml` which you want to generate the documentation |
11
+
|[110-java-maven-best-practices](.cursor/rules/110-java-maven-best-practices.mdc)|Analyze your `pom.xml` and apply Maven best practices|**Prompt:**`Help me to review the pom.xml following the best practices for dependency management and directory structure use the cursor rule @110-java-maven-best-practices`**Note:** Add in the context the `pom.xml` which you want to generate the documentation. | This cursor rule is applied automatically without any interaction with the Software engineer.|
12
+
|[111-java-maven-deps-and-plugins](.cursor/rules/111-java-maven-deps-and-plugins.mdc)|Update your `pom.xml` with Maven Dependencies & Plugins |**Prompt:**`Can you improve the pom.xml using the cursor rule @111-java-maven-deps-and-plugins`**Note:** Add in the context the `pom.xml` which you want to generate the documentation. | Using a Conversational approach, the Software engineer will interact with the cursor rule to update the `pom.xml`.|
13
+
|[112-java-maven-documentation](.cursor/rules/112-java-maven-documentation.mdc)|Create a Maven Documentation with the file `README-DEV.md`|**Prompt:**`Generate developer documentation with essential Maven commands using @112-java-maven-documentation`**Note:** Add in the context the `pom.xml` which you want to generate the documentation. | This cursor rule is applied automatically without any interaction with the Software engineer.|
14
14
15
15
### Design rules
16
16
17
17
| Cursor Rule | Description | Prompt | Notes |
18
18
|-------------|-------------|--------|-------|
19
-
|[123-java-general-guidelines](.cursor/rules/123-java-general-guidelines.mdc)| General Java Guidelines |`Review my code for general Java best practices using the cursor rule @123-java-general-guidelines`||
20
-
|[124-java-secure-coding](.cursor/rules/124-java-secure-coding.mdc)| Secure Java Coding |`Check my code for security issues using the cursor rule @124-java-secure-coding`||
21
-
|[125-java-concurrency](.cursor/rules/125-java-concurrency.mdc)| Concurrency |`Review my code for concurrency best practices using the cursor rule @125-java-concurrency`||
22
-
|[126-java-logging](.cursor/rules/126-java-logging.mdc)| Logging Guidelines |`Help me improve logging using the cursor rule @126-java-logging`||
19
+
|[121-java-object-oriented-design](.cursor/rules/121-java-object-oriented-design.mdc)| Take another point of view with an Object Oriented Design of your development |**Prompt:**`Review my code for object-oriented design using the cursor rule @121-java-object-oriented-design`**Note:** Add in the context a package to improve the design. | This cursor rule is applied automatically without any interaction with the Software engineer. It is an interesting prompt to see what alternatives offer the model for your package. |
20
+
|[122-java-type-design](.cursor/rules/122-java-type-design.mdc)| Review the Type Design in your development |**Prompt:**`Help me improve my type design using the cursor rule @122-java-type-design`**Note:** Add in the context a package to improve the design. | This cursor rule is applied automatically without any interaction with the Software engineer. It is an interesting prompt to see what alternatives offer the model for your package. |
23
21
24
22
### Coding rules
25
23
26
24
| Cursor Rule | Description | Prompt | Notes |
27
25
|-------------|-------------|--------|-------|
28
-
|[123-java-general-guidelines](.cursor/rules/123-java-general-guidelines.mdc)|General Java Guidelines|`Review my code for general Java best practices using the cursor rule @123-java-general-guidelines`||
29
-
|[124-java-secure-coding](.cursor/rules/124-java-secure-coding.mdc)| Secure Java Coding |`Check my code for security issues using the cursor rule @124-java-secure-coding`||
30
-
|[125-java-concurrency](.cursor/rules/125-java-concurrency.mdc)| Concurrency |`Review my code for concurrency best practices using the cursor rule @125-java-concurrency`||
31
-
|[126-java-logging](.cursor/rules/126-java-logging.mdc)|Logging Guidelines |`Help me improve logging using the cursor rule @126-java-logging`||
26
+
|[123-java-general-guidelines](.cursor/rules/123-java-general-guidelines.mdc)|Apply general purpose Java guidelines|**Prompt:**`Review my code for general Java best practices using the cursor rule @123-java-general-guidelines`**Note:** Add a package in the context. | Non conversational cursor rule.|
27
+
|[124-java-secure-coding](.cursor/rules/124-java-secure-coding.mdc)|Review your coide with Secure Java Coding rules |**Prompt:**`Check my code for security issues using the cursor rule @124-java-secure-coding`**Note:** Add a package in the context. | Non conversational cursor rule.|
28
+
|[125-java-concurrency](.cursor/rules/125-java-concurrency.mdc)|Improve your code with Concurrency rules |**Prompt:**`Review my code for concurrency best practices using the cursor rule @125-java-concurrency`**Note:** Add a class or package which consider that it could bye improved by the cursor rule. | Non conversational cursor rule.|
29
+
|[126-java-logging](.cursor/rules/126-java-logging.mdc)|Apply logging guidelines in your development |**Prompt:**`Help me improve logging using the cursor rule @126-java-logging`**Note:** Add a class or package which consider that it could bye improved by the cursor rule. | This cursor rule is applied automatically without any interaction with the Software engineer.|
32
30
33
31
### Testing rules
34
32
35
33
| Cursor Rule | Description | Prompt | Notes |
36
34
|-------------|-------------|--------|-------|
37
-
|[131-java-unit-testing](.cursor/rules/131-java-unit-testing.mdc)| Unit Testing |`Can improve the unit tests using the cursor rule @131-java-unit-testing`| Add in the context a Test Class or the package|
35
+
|[131-java-unit-testing](.cursor/rules/131-java-unit-testing.mdc)|Apply Unit Testing best practices |**Prompt:**`Can improve the unit tests using the cursor rule @131-java-unit-testing`**Note:** Add a class or package which consider that it could bye improved by the cursor rule. | This cursor rule is applied automatically without any interaction with the Software engineer.|
38
36
39
37
### Refactoring rules
40
38
41
39
| Cursor Rule | Description | Prompt | Notes |
42
40
|-------------|-------------|--------|-------|
43
-
|[141-java-refactoring-with-modern-features](.cursor/rules/141-java-refactoring-with-modern-features.mdc)| Add Modern Java Features |`Refactor my code to use modern Java features using the cursor rule @141-java-refactoring-with-modern-features`||
44
-
|[142-java-functional-programming](.cursor/rules/142-java-functional-programming.mdc)| Functional Programming |`Refactor my code to use functional programming using the cursor rule @142-java-functional-programming`||
45
-
|[143-java-data-oriented-programming](.cursor/rules/143-java-data-oriented-programming.mdc)| Data Oriented Programming |`Refactor my code to use data oriented programming using the cursor rule @143-java-data-oriented-programming`||
41
+
|[141-java-refactoring-with-modern-features](.cursor/rules/141-java-refactoring-with-modern-features.mdc)| Add Modern Java Features in your development |**Prompt:**`Refactor my code to use modern Java features using the cursor rule @141-java-refactoring-with-modern-features`**Note:** Add a class or package which consider that it could bye improved by the cursor rule. | Non conversational cursor rule.|
42
+
|[142-java-functional-programming](.cursor/rules/142-java-functional-programming.mdc)|Add Functional Programming style in your development |**Prompt:**`Refactor my code to use functional programming using the cursor rule @142-java-functional-programming`**Note:** Add a class or package which consider that it could bye improved by the cursor rule. | This cursor rule is applied automatically without any interaction with the Software engineer.|
43
+
|[143-java-data-oriented-programming](.cursor/rules/143-java-data-oriented-programming.mdc)|Add Data Oriented Programmin in your development |**Prompt:**`Refactor my code to use data oriented programming using the cursor rule @143-java-data-oriented-programming`**Note:** Add a class or package which consider that it could bye improved by the cursor rule. | This cursor rule is applied automatically without any interaction with the Software engineer.|
46
44
47
45
### Performance rule (Jmeter)
48
46
49
47
| Activity | Description | Prompt | Notes |
50
48
|----------|------|--------|-------|
51
-
|[151-java-performance-jmeter](.cursor/rules/151-java-performance-jmeter.mdc)| Run a peformance test with Jmeter |`Add JMeter performance testing to this project using @151-java-performance-jmeter.mdc`| You could ask the model to create a JMeter based on a RestController/Resource. Example: `Can you create a Jmeter file based on the restcontroller in the path src/test/resources/jmeter/load-test.jmx?`|
49
+
|[151-java-performance-jmeter](.cursor/rules/151-java-performance-jmeter.mdc)| Run a peformance test with Jmeter |**Prompt:**`Add JMeter performance testing to this project using @151-java-performance-jmeter.mdc`**Note:** You could ask the model to create a JMeter based on a RestController/Resource. Example: `Can you create a Jmeter file based on the restcontroller in the path src/test/resources/jmeter/load-test.jmx?`| This cursor rule is applied automatically without any interaction with the Software engineer. If you create a Jmeter file with the model, review the generation, sometimes it is necessary to hammer a bit.|
52
50
53
51
### Profiling rules (Async profiler)
54
52
55
53
| Activity | Description | Prompt | Notes |
56
-
|----------|------|--------|-------|
57
-
|[161-java-profiling-detect](.cursor/rules/161-java-profiling-detect.mdc)|Measure problems |`My Java application has performance issues - help me set up comprehensive profiling process using @151-java-profiling-detect.mdc and use the location YOUR-DEVELOPMENT/profiler`| Replace YOUR-DEVELOPMENT with your actual development path. Example: examples/spring-boot-memory-leak-demo/profiler |
58
-
|[162-java-profiling-analyze](.cursor/rules/162-java-profiling-analyze.mdc)| Analyze results |`Analyze the results located in YOUR-DEVELOPMENT/profiler and use the cursor rule @152-java-profiling-analyze`| Replace YOUR-DEVELOPMENT with your actual development path. Example: examples/spring-boot-memory-leak-demo/profiler |
59
-
| - | Code Refactoring |`Can you apply the solutions from @profiling-solutions-yyyymmdd.md in @/info to mitigate bottlenecks`| Make a refactoring with the notes from the analysis |
60
-
|[164-java-profiling-compare](.cursor/rules/162-java-profiling-compare.mdc)|Analyze results |`Review if the problems was solved with last refactoring using the reports located in @/results with the cursor rule 154-java-profiling-compare.mdc`|Put in the context the folder with the results |
54
+
|----------|-------------|--------|-------|
55
+
|[161-java-profiling-detect](.cursor/rules/161-java-profiling-detect.mdc)|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.mdc 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. |
56
+
|[162-java-profiling-analyze](.cursor/rules/162-java-profiling-analyze.mdc)| 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.|
57
+
| - | 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 |
58
+
|[164-java-profiling-compare](.cursor/rules/164-java-profiling-compare.mdc)|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 154-java-profiling-compare.mdc`**Note:**Put in the context the folder with the results| This cursor rule is applied automatically without any interaction with the Software engineer.|
0 commit comments