Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements to README #552

Merged
merged 8 commits into from
Sep 8, 2022
Merged

Improvements to README #552

merged 8 commits into from
Sep 8, 2022

Conversation

nre-ableton
Copy link
Contributor

@nre-ableton nre-ableton commented Aug 25, 2022

Inspired by the discussion in #549 (comment). This PR fixes the README to be use a more consistent style and tone, specifically by:

  • Use 90-character lines
  • en_US spelling/grammar/punctuation rules
  • Fix Groovy example code to be more "CodeNarc-friendly"
  • Update examples for JUnit 5
  • Add information about Java requirements

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.

- 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.
@nre-ableton nre-ableton merged commit 190463e into master Sep 8, 2022
@nre-ableton nre-ableton deleted the nre/master/improve-readme branch September 8, 2022 07:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant