feat: add Java README generator rule for project onboarding#8
Merged
Conversation
Owner
jmochel
commented
Nov 13, 2025
jmochel
commented
- Introduced a new rule for generating README.md files tailored for Java projects, supporting Maven and Gradle build tools.
- Defined structure and content guidelines to facilitate quick onboarding, including sections for Quick Start, installation, usage, and troubleshooting.
- Included quality gates to ensure comprehensive documentation and maintainability.
- Added references to best practices and examples for effective README creation.
- Introduced a new rule for generating README.md files tailored for Java projects, supporting Maven and Gradle build tools. - Defined structure and content guidelines to facilitate quick onboarding, including sections for Quick Start, installation, usage, and troubleshooting. - Included quality gates to ensure comprehensive documentation and maintainability. - Added references to best practices and examples for effective README creation.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.