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

chore: configure SpotBugs plugin fb-contrib #5126

Merged
merged 1 commit into from May 4, 2024

Conversation

vil02
Copy link
Member

@vil02 vil02 commented Apr 29, 2024

This PR configures fb-contrib.

Continuation of #5122.

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized it.
  • All filenames are in PascalCase.
  • All functions and variable names follow Java naming conventions.
  • All new algorithms have a URL in their comments that points to Wikipedia or other similar explanations.
  • All new code is formatted with clang-format -i --style=file path/to/your/file.java

@codecov-commenter
Copy link

codecov-commenter commented Apr 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.37%. Comparing base (dda3c9c) to head (6299474).

Additional details and impacted files
@@            Coverage Diff            @@
##             master    #5126   +/-   ##
=========================================
  Coverage     37.37%   37.37%           
- Complexity     2350     2351    +1     
=========================================
  Files           517      517           
  Lines         15613    15613           
  Branches       2968     2968           
=========================================
+ Hits           5835     5836    +1     
  Misses         9490     9490           
+ Partials        288      287    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@vil02 vil02 marked this pull request as ready for review April 29, 2024 15:38
@vil02 vil02 enabled auto-merge (squash) April 29, 2024 15:38
Copy link
Member

@BamaCharanChhandogi BamaCharanChhandogi left a comment

Choose a reason for hiding this comment

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

@vil02 Could you tell me why you added all of this? I am not aware of it. Could you explain it to me?

@vil02
Copy link
Member Author

vil02 commented May 1, 2024

@vil02 Could you tell me why you added all of this? I am not aware of it. Could you explain it to me?

The changes in pom.xml add the fb-contrib plugin to SpotBugs. The changes in spotbugs-exclude.xml ignore some of the checks (i.e. if they were not ignored, then SpotBugs would report problems and the whole CI would fail).

SpotBugs is a static analysis tool for Java. It will help us with the code reviews (so we could focus on important stuff like general design). More checks makes the analysis more restrictive. The size of spotbugs-exclude.xml shows how much technical debt we have in our repository. My long term strategy is to remove as much rules from the ignore list as possible.

I had a brief look on some of the rules, and they are really valuable. It is a pity that this was not present from the very beginning.

@vil02 vil02 force-pushed the configure_fb-contrib branch 4 times, most recently from 4a5b394 to 364f0e7 Compare May 3, 2024 19:17
Copy link
Member

@BamaCharanChhandogi BamaCharanChhandogi left a comment

Choose a reason for hiding this comment

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

LGTM,Thanks

@vil02 vil02 merged commit 6bde5d7 into TheAlgorithms:master May 4, 2024
4 checks passed
@vil02 vil02 deleted the configure_fb-contrib branch May 4, 2024 16:03
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