dockstore / dockstore

Our VM/Docker sharing infrastructure and management component
https://dockstore.org/
Apache License 2.0
116 stars 27 forks source link

(Sonar) Fixed finding: "@Override should be used on overriding and implementing methods" #5907

Closed pixeeai closed 1 week ago

pixeeai commented 2 weeks ago

Remediation

This change fixes "@Override should be used on overriding and implementing methods" (id = java:S1161) identified by Sonar.

Details

This change adds missing @Override to known subclasses. Documenting inheritance will help readers and static analysis tools understand the code better, spot bugs easier, and in general lead to more efficient and effective review.

Our changes look something like this:

  interface AcmeParent {
     void doThing();
  } 

  class AcmeChild implements AcmeParent {

+   @Override
    void doThing() {
      thing();
    }

  }
More reading * [https://rules.sonarsource.com/java/RSPEC-1161/](https://rules.sonarsource.com/java/RSPEC-1161/)

🧚🤖 Powered by Pixeebot

Feedback | Community | Docs | Codemod ID: sonar:java/add-missing-override-s1161

pixeeai commented 2 weeks ago

This change was autogenerated from a GitHub app - called Pixeebot. A code-quality GitHub App for source code.

Free installation for Open Source projects: 👇 https://github.com/marketplace/pixeebot-automated-code-fixes

denis-yuen commented 1 week ago

Probably need to work out something better for CircleCI and secrets, but this seems harmless enough and builds locally.