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

Fix minor typos #692

Merged
merged 1 commit into from Nov 22, 2022
Merged

Fix minor typos #692

merged 1 commit into from Nov 22, 2022

Conversation

marcwrobel
Copy link
Contributor

@marcwrobel marcwrobel commented Nov 22, 2022

Fix small typos in :

  • various documentations,
  • test method and class names,
  • test strings,
  • javadoc and comments.

Proposed commit message:

Fix various typos (#692)

This PR fixes various typos in

* documentations,
* test method and class names,
* test strings,
* Javadoc and comments.

PR: #692

PR checklist

The following checklist shall help the PR's author, the reviewers and maintainers to ensure the quality of this project.
It is based on our contributors guidelines, especially the "writing code" section.
It shall help to check for completion of the listed points.
If a point does not apply to the given PR's changes, the corresponding entry can be simply marked as done.

Documentation (general)

  • There is documentation (Javadoc and site documentation; added or updated)
  • There is implementation information to describe why a non-obvious source code / solution got implemented
  • Site documentation has its own .adoc file in the docs folder, e.g. docs/report-entries.adoc
  • Site documentation in .adoc file references demo in src/demo/java instead of containing code blocks as text
  • Only one sentence per line (especially in .adoc files)
  • Javadoc uses formal style, while sites documentation may use informal style

Documentation (new extension)

  • The docs/docs-nav.yml navigation has an entry for the new extension
  • The package-info.java contains information about the new extension

Code

  • Code adheres to code style, naming conventions etc.
  • Successful tests cover all changes
  • There are checks which validate correct / false usage / configuration of a functionality and there are tests to verify those checks
  • Tests use AssertJ or our own PioneerAssert (which are based on AssertJ)

Contributing

  • A prepared commit message exists
  • The list of contributions inside README.md mentions the new contribution (real name optional)

@marcwrobel marcwrobel marked this pull request as ready for review November 22, 2022 16:01
Fix small typos in :
- various documentations,
- test method and class names,
- test strings,
- javadoc and comments.

PR: #692
Copy link
Member

@Michael1993 Michael1993 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 😊 Thank you!

@beatngu13 beatngu13 added the full-build Triggers full build suite on PR label Nov 22, 2022
Copy link
Member

@beatngu13 beatngu13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Finally someone who is as bothered as I am by missing periods at the end of sentences – thank you! 😉

@beatngu13 beatngu13 merged commit 1330e8b into junit-pioneer:main Nov 22, 2022
@nipafx
Copy link
Member

nipafx commented Nov 30, 2022

@marcwrobel How did you find all these? Are you just randomly reading Pioneer documentation and source code? 😂 Very impressive, thank you very much! ❤️

@beatngu13 That's why comments should start with lower case letters - then they're not sentences and need no period. 😜

@marcwrobel
Copy link
Contributor Author

@nipafx nope, I just used Intellij IDEA 😋. Proofreading inspections are pretty good at finding typos and grammar issues (all thanks to the bundled grazie plugin).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
full-build Triggers full build suite on PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants