Rewrite README with usage, status and version guidance - #110
Merged
Conversation
The README was four lines: a project name and two badges. It did not say what the library does, how to depend on it, or that it is a JUnit 5 extension. Adds a description, a dependency snippet with test scope, a usage example checked against this repository's own tests, the requirements and documentation links. Part of codehaus-plexus/.github#58
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.
Part of codehaus-plexus/.github#58. Same skeleton as the merged pilots.
This was the thinnest README in the organisation — four lines, being a project name and two badges. Nothing said it was a JUnit 5 extension, or how to use it.
It now has the thing someone actually needs:
Checked against this repository's own
PlexusTestJavaxTest, which uses exactly that shape.Also adds
<scope>test</scope>on the dependency snippet — easy to leave off, and wrong without it — thePlexusTestConfigurationcustomisation hook, the JUnit 5 requirement, and doc links. All links checked for a 200.Ran
mvn spotless:apply.