Improvements to README #552
Merged
Conversation
This file contains 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
- Use title case - Use present progressive tense - Improve wording in some places
Also de-indent code examples.
- Use proper types - Update to JUnit 5 - Fix indentation/whitespace - Make CodeNarc-friendly
This is covered in the Jenkins shared pipeline documentation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Inspired by the discussion in #549 (comment). This PR fixes the README to be use a more consistent style and tone, specifically by:
This PR is open to the community to review; I would appreciate all input and suggestions. Assuming there are no dissenting reviews, I will merge this PR in 2 weeks on 8 Sept 2022.