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

[OTHER] Enable more checks in checkstyle #5119

Open
10 of 21 tasks
vil02 opened this issue Apr 25, 2024 · 12 comments
Open
10 of 21 tasks

[OTHER] Enable more checks in checkstyle #5119

vil02 opened this issue Apr 25, 2024 · 12 comments

Comments

@vil02
Copy link
Member

vil02 commented Apr 25, 2024

What would you like to share?

#5110 introduced checkstyle. The config file has some of the rules commented out. It might a good idea to introduce some of them and discuss why the other ones are not needed in this repository.

List of checks which should be introduced

Few of the obvious checks, which should be introduced:

(@siriak, @BamaCharanChhandogi feel free to edit the list above)

Additional information

How to contribute

  1. select one check form the list above such that no one else is working on (and is not done yet),
  2. write a comment "Hey, I am working on XYZ", where XYZ is your selected check,
  3. in your fork, please create a branch like enable_XYZ,
  4. uncomment the XYZ check in the checkstyle.xml,
  5. run mvn checkstyle:check and fix all of the errors - please keep your changes minimal,
  6. commit your changes with a message like "style: enable XYZ in checkstyle",
  7. create a pull-request and mention this issue by writing something like "Related to [OTHER] Enable more checks in checkstyle #5119".
@vil02 vil02 added the awaiting triage Awaiting triage from a maintainer label Apr 25, 2024
@vil02
Copy link
Member Author

vil02 commented Apr 26, 2024

I will work on EmptyStatement.

@marysiuniq
Copy link
Contributor

Hey, I will be working on ModifierOrder.

@marysiuniq
Copy link
Contributor

Now, I will be working on ConstantName.

@vil02
Copy link
Member Author

vil02 commented May 3, 2024

I will work on RedundantModifier.

@vil02
Copy link
Member Author

vil02 commented May 4, 2024

I will slowly work on AvoidStarImport.

@VedSansare89
Copy link

Hey, I will be working on MethodName

@vil02
Copy link
Member Author

vil02 commented May 6, 2024

I will work on ArrayTypeStyle.

@vil02
Copy link
Member Author

vil02 commented May 7, 2024

I will work on HideUtilityClassConstructor.

@vil02
Copy link
Member Author

vil02 commented May 9, 2024

@siriak, @BamaCharanChhandogi I have extended the list of obvious checks. Please have a look and edit the list if needed.

@CodaBlurd
Copy link
Contributor

CodaBlurd commented May 10, 2024

Hi, I will be working on FinalClass.

@CodaBlurd
Copy link
Contributor

I will work on EqualsHashCode.

@CodaBlurd
Copy link
Contributor

I will work on InnerAssignment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants