Skip to content

Commit 0fa16e2

Browse files
committed
Improving README.md
1 parent bbbc013 commit 0fa16e2

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ The [available System prompts for Java](./CURSOR-RULES-JAVA.md) cover aspects li
1212

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

15-
The repository was designed to offer support for Cursor, but other tools have evolved and now offer better support for System prompts. The repository executes regular regression testing for IDEs like *Cursor*, *Cursor CLI*, *Claude Code*, *GitHub Copilot* & *JetBrains Junie*.
15+
The repository was designed to support Cursor, but other tools have evolved and now offer better support for system prompts. The repository runs regular regression tests for IDEs and tools such as *Cursor*, *Cursor CLI*, *Claude Code*, *GitHub Copilot*, and *JetBrains Junie*.
1616

17-
⚠️ **Note:** Currently, the best environments to use this repository are: *Cursor*, *Cursor CLI* & *Claude Code*. If you use *JetBrains IntelliJ IDEA*, you could combine it with *Cursor CLI* or *Claude Code*. Further information about the latest review [here](./documentation/reviews/review-20250829.md) (**Last Update:** 2025/08/29).
17+
⚠️ **Note:** Currently, the best environments in which to use this repository are *Cursor*, *Cursor CLI*, and *Claude Code*. If you use *JetBrains IntelliJ IDEA*, you can combine it with *Cursor CLI* or *Claude Code*. Further information is available in the latest review [here](./documentation/reviews/review-20250829.md) (**Last update:** 2025/08/29).
1818

1919
## What is a System prompt?
2020

@@ -26,33 +26,33 @@ A system prompt is a set of instructions given to an AI model that defines how i
2626

2727
The repository provides System prompts that can behave interactively or non-interactively, depending on how the user employs them.
2828

29-
- **System prompts:** `Create a UML class diagram with @170-java-documentation without any question` or `Add Maven Enforcer plugin only from the rule @112-java-maven-plugins without any question`
30-
- **Interactive System Prompts:** Prompts that ask questions and have conditional logic. Examples: `Improve the pom.xml using the cursor rule @112-java-maven-plugins` or `Generate technical documentation & diagrams about the project with the cursor rule @170-java-documentation`
29+
- **System prompts:** `Create a UML class diagram with @170-java-documentation without asking questions` or `Add the Maven Enforcer plugin using the rule @112-java-maven-plugins without asking questions`
30+
- **Interactive System Prompts:** Prompts that ask questions and include conditional logic. Examples: `Improve the pom.xml using the cursor rule @112-java-maven-plugins` or `Generate technical documentation and diagrams about the project with the cursor rule @170-java-documentation`
3131

32-
### Types of customized behaviours for System prompts
32+
### Types of customized behaviours for system prompts
3333

3434
- **Consultative Interactive:** Prompts that suggest alternatives to improve software development. Examples: `Improve the class/classes added in the context applying the system prompt @128-java-generics with the behaviour @behaviour-consultative-interaction` or `Improve the class/classes added in the context applying the system prompt @131-java-unit-testing with the behaviour @behaviour-consultative-interaction`
35-
- **Progressive Learning:** Using the System prompts, you can generate courses about a particular topic in order to understand better the changes generated by Models. Example: `Create a course about @128-java-generics.md using the behavior @behaviour-progressive-learning.md and put the course in @courses`
35+
- **Progressive Learning:** Using the system prompts, you can generate courses about a particular topic to better understand the changes generated by models. Example: `Create a course about @128-java-generics.md using the behavior @behaviour-progressive-learning.md and place the course in @courses`
3636

3737
### Java development workflow
3838

39-
Adding AI tools to the Java development workflow can increase the possibilities of implementing software specifications on time and with quality.
39+
Adding AI tools to the Java development workflow can increase the likelihood of implementing software specifications on time and with quality.
4040

4141
![](./documentation/images/workflow.png)
4242

43-
**Note:** Remember that if you use models and ask questions about recent topics like *Java 25*, it is probable that models will not provide accurate answers.
43+
**Note:** Remember that if you use models and ask questions about recent topics like *Java 25*, it is likely that the models will not provide accurate answers.
4444

4545
### Data pipelines workflow
4646

47-
Adding AI tools in your Data Pipeline could offer new opportunties to offer more value. (Examples: Automatic Coding, Code Refactoring, Continous profiling, others...)
47+
Adding AI tools to your data pipeline can provide new opportunities to deliver more value (examples: automatic coding, code refactoring, continuous profiling, and others).
4848

4949
![](./documentation/images/data-pipeline-workflow.png)
5050

5151
## Getting started
5252

53-
New to this repository? Start with our [comprehensive guide](./documentation/GETTING-STARTED.md) for a quick introduction to setting up and using the Cursor rules and later you could read about [how to integrate System prompts](./documentation/HOW-TO-USE.md) into your development workflow and maximize their effectiveness in your daily coding tasks. For full understanding about this project, follow this course about [Mastering System Prompts for Java](https://jabrena.github.io/cursor-rules-java/courses/system-prompts-java/index.html)
53+
New to this repository? Start with our [comprehensive guide](./documentation/GETTING-STARTED.md) for a quick introduction to setting up and using the Cursor rules, then read about [how to integrate system prompts](./documentation/HOW-TO-USE.md) into your development workflow to maximize their effectiveness in your daily coding tasks. For a full understanding of this project, follow the course [Mastering System Prompts for Java](https://jabrena.github.io/cursor-rules-java/courses/system-prompts-java/index.html).
5454

55-
## How many System prompts for Java include this project?
55+
## How many system prompts for Java does this project include?
5656

5757
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.
5858

@@ -68,19 +68,19 @@ This framework transforms AI from a general assistant into a specialized consult
6868

6969
### Lack of determinism
7070

71-
From the beginning, you need to know that results provided by interactions with the different `Cursor rules` are not deterministic due to the nature of the models, but this fact should not be considered negative. Software engineers do not always have the same idea to solve a problem, and you can find an analogy in this fact.
71+
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 fact is possible to be mitigated with `clear goals` and `validation checkpoints`.
7272

7373
### Limits of interactions with models
7474

75-
Models are able to generate code but they cannot run code with your local data. To address this limitation, you can observe that a few prompts provide scripts to bridge the gap on the model side.
75+
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.
7676

7777
## Contribute
7878

79-
If you have great ideas, [read the following document](./CONTRIBUTING.md) for contributing.
79+
If you have great ideas, [read the following document](./CONTRIBUTING.md) to contribute.
8080

8181
## Examples
8282

83-
The repository includes [a collection of examples](./examples/) where you can explore the possibilities from this collection of System prompts designed for Java.
83+
The repository includes [a collection of examples](./examples/) where you can explore the possibilities of these system prompts designed for Java.
8484

8585
## Architectural decision records, ADR
8686

0 commit comments

Comments
 (0)