Minor Java and README improvements #429
Open
+7
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make sure it uses latest Java Version, inserts Unit Tests and especially follow best practice guideline to skip mvn install for more performant verification builds.
- fix quoting of asteriks - reword instruction file names - mention as needed instruction invocation - support the more Portable AGENTS.md
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances Java development instructions and clarifies the README documentation for GitHub Copilot instructions. The changes improve Java build practices, update guidance for instruction files, and reference the new AGENTS.md file.
Key Changes:
- Updated Java instructions to use
mvn clean verifyinstead ofinstall, added guidance for checking project configuration, and emphasized unit test coverage - Clarified instruction file usage in the README with references to AGENTS.md and corrected markdown escaping
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| instructions/java.instructions.md | Enhanced Java instructions with build best practices, project configuration checks, and test coverage guidance |
| docs/README.instructions.md | Updated documentation to reference AGENTS.md, corrected markdown formatting, and clarified instruction file usage |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Clarified installation and usage instructions for custom instructions.
Author
|
Let me know if I should Squash them |
aaronpowell
approved these changes
Nov 24, 2025
aaronpowell
requested changes
Nov 24, 2025
Comment on lines
+11
to
+14
| - Copy these instructions to your `.github/copilot-instructions.md` or `AGENTS.md` file in your workspace, or | ||
| - Create task-specific `*.instructions.md` files in your workspace's `.github/instructions/` folder | ||
| - Instructions automatically apply to Copilot behavior once installed in your workspace | ||
| - You can reference task specific instructions (for one-off migrations) in the prompt |
Contributor
There was a problem hiding this comment.
This whole file is auto generated and templated from the constants.mjs file
Author
There was a problem hiding this comment.
Ok, lets handle it seperately, will update the PR
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.Description
Improve Java instruction (maven performance, Java version uptake and Unit test coverqge)
Add clarify to instructions README and introduce AGENTS.md
Type of Contribution
Additional Notes
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.