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

Just some code smell cleanups to appease Sonar #640

Merged
merged 6 commits into from May 24, 2022
Merged

Conversation

Michael1993
Copy link
Member

@Michael1993 Michael1993 commented May 21, 2022

Proposed commit message:

Small fixes for Sonar (#640)

This commit contains small changes related to Sonar code analysis.

PR: #640

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)

@Michael1993 Michael1993 changed the title Just some code smell cleanups to appease ~~our supreme overlord~~ Sonar Just some code smell cleanups to appease Sonar May 21, 2022
@beatngu13 beatngu13 self-requested a review May 21, 2022 16:45
class NoJsonParserConfiguredExceptionTest {

@Test
void shouldBeUnchecked() {
Copy link
Member

Choose a reason for hiding this comment

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

Really worth a test? 🫣

Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure. What else could we do?

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.

Could you prepare a commit message? Then feel free to merge. 👍

Copy link
Member

@Bukama Bukama left a comment

Choose a reason for hiding this comment

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

LGTM (even that the test is strange)

@Bukama Bukama merged commit 6a7a129 into main May 24, 2022
@Bukama Bukama deleted the bugfix/sonar-code-smells branch May 24, 2022 15:48
Bukama pushed a commit to Bukama/junit-pioneer that referenced this pull request Sep 20, 2022
This commit contains small changes related to Sonar code analysis.

PR: junit-pioneer#640
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

3 participants