checkstyle: remove VariableDeclarationUsageDistance suppression #875
Comments
|
I'm interested in contributing to this issue. Can I do that? Also before I start working it, would you mind sparing your time explaining what the fix will be like and pointing me to some resources to get started. |
|
You can work on the issue, but since the issue description is a list of exactly what needs to be done -- what additional information were you looking for? |
|
Okay, I'll give this a try -- checkstyle is a set of validations that ensure code quality on a project. In case with this project, the codebase switched from Spring style to Google style a couple of years ago. As a result of that, we left some code quality technical debt in the form of these disabled checkstyle rules. The first thing you'd want to do is check out the project source code -- Once checked out, you'd want switch into the project's directory, and build it to make sure everything works correctly on your machine -- Once that is done, you can start looking into the task. Like the description says, remove |
|
Thanks a lot for this great detailing. I will try resolving this issue.
…On Thu, Sep 8, 2022 at 11:34 PM Elena Felder ***@***.***> wrote:
Okay, I'll give this a try -- checkstyle is a set of validations that
ensure code quality on a project. In case with this project, the codebase
switched from Spring style to Google style a couple of years ago. As a
result of that, we left some code quality technical debt in the form of
these disabled checkstyle rules.
The first thing you'd want to do is check out the project source code -- git
checkout ***@***.***:GoogleCloudPlatform/spring-cloud-gcp.git (that
will require you to set up certificate authentication per [github docs](
https://docs.github.com/en/authentication/connecting-to-github-with-ssh.
You may choose any other authentication method, but the checkout command
will change slightly).
Once checked out, you'd want switch into the project's directory, and
build it to make sure everything works correctly on your machine -- mvn
clean install. Note that you will need Maven and Java installed locally
for this to work.
Once that is done, you can start looking into the task. Like the
description says, remove <suppress
checks="VariableDeclarationUsageDistance" files=".*"/> from
checkstyle-suppressions.xml file. Then try running mvn validate, and
seeing the results. Your goal is to iteratively fix the checkstyle failures.
—
Reply to this email directly, view it on GitHub
<#875 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AZMJULMSHMDLUZITVADX3WDV5ITBVANCNFSM5LXM6ESQ>
.
You are receiving this because you commented.Message ID:
***@***.***>
--
The information contained in this electronic communication is intended
solely for the individual(s) or entity to which it is addressed. It may
contain proprietary, confidential and/or legally privileged information.
Any review, retransmission, dissemination, printing, copying or other use
of, or taking any action in reliance on the contents of this information by
person(s) or entities other than the intended recipient is strictly
prohibited and may be unlawful. If you have received this communication in
error, please notify us by responding to this email or telephone and
immediately and permanently delete all copies of this message and any
attachments from your system(s). The contents of this message do not
necessarily represent the views or policies of BITS Pilani.
|
<suppress checks="VariableDeclarationUsageDistance" files=".*"/>fromcheckstyle-suppressions.xml.Rinse, repeat until all missing javadoc is written.
The text was updated successfully, but these errors were encountered: