search

GoogleCloudPlatform / spring-cloud-gcp

New home for Spring Cloud GCP development starting with version 2.0.
Apache License 2.0
429 stars 319 forks source link

checkstyle: remove OverloadMethodsDeclarationOrder suppression #874

Open elefeint opened 2 years ago

elefeint commented 2 years ago

1) Remove <suppress checks="OverloadMethodsDeclarationOrder" files=".*"/> from checkstyle-suppressions.xml. 2) Write javadoc to address as many issues as you want to handle at a time. 3) Put the suppression back if any violations remain. 4) Send PR. Rinse, repeat until all missing javadoc is written.

2021H1030044G commented 2 years ago

Can I contribute in the above issue?

elefeint commented 2 years ago

@2021H1030044G You can work on this one. Out of curiosity, are you in the same college class with @2021H1030039G?

Please don't comment on multiple issues with identical comments; it looks like spam.

2021H1030044G commented 2 years ago

Yaa, we are from same college. We have to do a project for one of our course.

Thanks & Regards, Deepika Makhija

On Thu 8 Sep, 2022, 11:12 PM Elena Felder, @.***> wrote:

@2021H1030044G https://github.com/2021H1030044G You can work on this one. Out of curiosity, are you in the same college class with @2021H1030039G https://github.com/2021H1030039G?

Please don't comment on multiple issues with identical comments; it looks like spam.

— Reply to this email directly, view it on GitHub https://github.com/GoogleCloudPlatform/spring-cloud-gcp/issues/874#issuecomment-1241033690, or unsubscribe https://github.com/notifications/unsubscribe-auth/AYJOEZV63322AC4YVNEWF33V5IQQRANCNFSM5LXM5C6Q . You are receiving this because you were mentioned.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.

elefeint commented 2 years ago

Makes sense. In general, sticking to issues annotated as good first issue will yield better results.

2021H1030039G commented 2 years ago

Can you please suggest us some resource to get started with the work on these issue.

On Thu, Sep 8, 2022, 23:18 Elena Felder @.***> wrote:

Makes sense. In general, sticking to issues annotated as good first issue https://github.com/topics/good-first-issue will yield better results.

— Reply to this email directly, view it on GitHub https://github.com/GoogleCloudPlatform/spring-cloud-gcp/issues/874#issuecomment-1241039696, or unsubscribe https://github.com/notifications/unsubscribe-auth/AYJOEX3XG65SZHQEC7DPJ23V5IRGNANCNFSM5LXM5C6Q . You are receiving this because you were mentioned.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.

elefeint commented 2 years ago

What additional information do you need that's not in the issue description?

2021H1030044G commented 2 years ago

Yeah that will be nice but there's weren't any issues labeled as good first issue.

Thanks for suggestions.

Thanks & Best Regards, Deepika Makhija

On Thu 8 Sep, 2022, 11:18 PM Elena Felder, @.***> wrote:

Makes sense. In general, sticking to issues annotated as good first issue https://github.com/topics/good-first-issue will yield better results.

— Reply to this email directly, view it on GitHub https://github.com/GoogleCloudPlatform/spring-cloud-gcp/issues/874#issuecomment-1241039696, or unsubscribe https://github.com/notifications/unsubscribe-auth/AYJOEZRNIE774VTIFYJRXVDV5IRGNANCNFSM5LXM5C6Q . You are receiving this because you were mentioned.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.

elefeint commented 2 years ago

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 git@github.com:GoogleCloudPlatform/spring-cloud-gcp.git (that will require you to set up certificate authentication per github docs. 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="OverloadMethodsDeclarationOrder" files=".*"/> from checkstyle-suppressions.xml file. Then try running mvn validate, and seeing the results. Your goal is to iteratively fix the checkstyle failures.