new java and springboot base best practices #22
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
|
@josephgonzales01 this is a great start! May I just suggest that you split Java and Spring instructions into their own individual files? |
suggestion applied |
|
This looks great. I'll ask it to be merged. Thanks @josephgonzales01 ! |
There was a problem hiding this comment.
Pull Request Overview
Adds foundational best practices and review instructions for Java and Spring Boot projects.
- Introduces
springboot.instructions.mdwith guidelines for Spring Boot development. - Introduces
java.instructions.mdwith Java-specific coding standards and checks.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| instructions/springboot.instructions.md | New Spring Boot development guidelines |
| instructions/java.instructions.md | New Java development guidelines |
| @@ -0,0 +1,58 @@ | |||
| --- | |||
| description: 'Guidelines for building Springboot base applications' | |||
| applyTo: '**/*.java, **/*.kt,' | |||
There was a problem hiding this comment.
The glob pattern has a trailing comma inside the quotes ('**/.java, **/.kt,') which may cause the applyTo pattern to not match correctly; consider removing the trailing comma or splitting into a list of patterns.
| applyTo: '**/*.java, **/*.kt,' | |
| applyTo: '**/*.java, **/*.kt' |
Copilot uses AI. Check for mistakes.
| @@ -0,0 +1,58 @@ | |||
| --- | |||
| description: 'Guidelines for building Springboot base applications' | |||
There was a problem hiding this comment.
The term 'Springboot' should be capitalized as 'Spring Boot' to match official naming conventions.
| description: 'Guidelines for building Springboot base applications' | |
| description: 'Guidelines for building Spring Boot base applications' |
Copilot uses AI. Check for mistakes.
|
@josephgonzales01 can you please review the steps documented here? Also, your PR is out of sync with the latest commit in the main branch. |
|
Hi Maintainer, I’ve addressed all comments and completed the remaining tasks. The PR is now ready for final review |
Title: feat: Expand Java ecosystem prompts and best practices
Description:
This pull request significantly expands the available guidance for Java ecosystem development by introducing a suite of new best practice prompts. These prompts build upon the existing instructions to provide more targeted and actionable advice
for common development tasks, improving consistency and code quality for developers using the agent.
Key Additions:
instructions/springboot.instructions.md: Introduces foundational guidelines for all Spring Boot development.instructions/java.instructions.md: Adds Java-specific coding standards and review checks.prompts/java-docs.prompt.md: Establishes best practices for writing comprehensive and standardized Javadoc comments.prompts/java-junit.prompt.md: Outlines modern best practices for writing effective unit tests with JUnit 5, covering test structure, assertions, and parameterized tests.prompts/java-springboot.prompt.md: A detailed guide for developing applications with Spring Boot and Java, covering project structure, dependency injection, testing, and security.prompts/kotlin-springboot.prompt.md: An equivalent guide tailored specifically for idiomatic Kotlin development with Spring Boot, highlighting features like data classes, primary constructors, null safety, and coroutine usage.