Skip to content

Commit bc0f789

Browse files
committed
Improving README
1 parent 9914ea6 commit bc0f789

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,22 @@ This collection of Cursor Rules for Java development, tries to enrich the develo
1010

1111
## Cursor Rules
1212

13-
- [Build: Maven Best Practices](.cursor/rules/110-java-maven-best-practices.mdc)
14-
- [Build: Maven Dependencies & Plugins](.cursor/rules/111-java-maven-deps-and-plugins.mdc)
15-
- [Build: Maven Documentation](.cursor/rules/112-java-maven-documentation.mdc)
16-
- [Design: Object Oriented Design](.cursor/rules/121-java-object-oriented-design.mdc)
17-
- [Design: Type Design](.cursor/rules/122-java-type-design.mdc)
18-
- [Coding: General Java Guidelines](.cursor/rules/123-java-general-guidelines.mdc)
19-
- [Coding: Secure Java Coding](.cursor/rules/124-java-secure-coding.mdc)
20-
- [Coding: Concurrency](.cursor/rules/125-java-concurrency.mdc)
21-
- [Coding: Logging Guidelines](.cursor/rules/126-java-logging.mdc)
22-
- [Testing: Unit Testing](.cursor/rules/131-java-unit-testing.mdc)
23-
- [Refactoring: Add Modern Java Features](.cursor/rules/141-java-refactoring-with-modern-features.mdc)
24-
- [Refactoring: Functional Programming](.cursor/rules/142-java-functional-programming.mdc)
25-
- [Refactoring: Data Oriented Programming](.cursor/rules/143-java-data-oriented-programming.mdc)
26-
- [Database: SQL Guidelines](.cursor/rules/500-sql.mdc)
13+
| Phase | Cursor Rule | Description | Prompt | Notes |
14+
|-------|-------------|-------------|--------|-------|
15+
| Build | [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 |
16+
| Build | [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 |
17+
| Build | [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 |
18+
| Design | [121-java-object-oriented-design](.cursor/rules/121-java-object-oriented-design.mdc) | Object Oriented Design | `Review my code for object-oriented design using the cursor rule @121-java-object-oriented-design` | Add in the context a package to improve the design |
19+
| Design | [122-java-type-design](.cursor/rules/122-java-type-design.mdc) | Type Design | `Help me improve my type design using the cursor rule @122-java-type-design` | Add in the context a package to improve the design |
20+
| Coding | [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` | |
21+
| Coding | [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` | |
22+
| Coding | [125-java-concurrency](.cursor/rules/125-java-concurrency.mdc) | Concurrency | `Review my code for concurrency best practices using the cursor rule @125-java-concurrency` | |
23+
| Coding | [126-java-logging](.cursor/rules/126-java-logging.mdc) | Logging Guidelines | `Help me improve logging using the cursor rule @126-java-logging` | |
24+
| Testing | [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 |
25+
| Refactoring | [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` | |
26+
| Refactoring | [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` | |
27+
| Refactoring | [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` | |
28+
| Database | [500-sql](.cursor/rules/500-sql.mdc) | SQL Guidelines | `Review my SQL code using the cursor rule @500-sql` | |
2729

2830
## Getting started
2931

0 commit comments

Comments
 (0)