Skip to content

chore: configure checkstyle #5110

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

Merged
merged 1 commit into from
Apr 24, 2024
Merged

Conversation

vil02
Copy link
Member

@vil02 vil02 commented Apr 21, 2024

This PR adds checkstyle to this project. The checkstyle.xml is derived from sun_checks.xml by commenting out some some of the rules - they are marked by TODO. I think it might be a good idea to introduce some of them in the future. I will create an issue, where one can discuss which rules should be enabled.

The build.yml will fail if any warning would be found.

At the moment there is some unused import in one of the tests. Fixed in #5113.

@siriak what is your opinion?

  • 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 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.23%. Comparing base (089b1f7) to head (6db59cc).

Additional details and impacted files
@@            Coverage Diff            @@
##             master    #5110   +/-   ##
=========================================
  Coverage     37.23%   37.23%           
  Complexity     2343     2343           
=========================================
  Files           517      517           
  Lines         15630    15630           
  Branches       2975     2975           
=========================================
  Hits           5820     5820           
  Misses         9522     9522           
  Partials        288      288           

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

@vil02 vil02 mentioned this pull request Apr 21, 2024
6 tasks
@vil02 vil02 marked this pull request as ready for review April 21, 2024 19:05
Copy link
Member

@siriak siriak 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, thanks!

@siriak siriak merged commit 7a42f68 into TheAlgorithms:master Apr 24, 2024
4 checks passed
@vil02 vil02 deleted the add_checkstyle branch April 24, 2024 12:27
@vil02 vil02 mentioned this pull request May 11, 2024
6 tasks
@vil02 vil02 mentioned this pull request Sep 20, 2024
6 tasks
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.

3 participants