Skip to content
This repository has been archived by the owner on Jul 23, 2024. It is now read-only.

Introduce checkstyle to enforce conventions #326

Merged
merged 9 commits into from
May 18, 2023

Conversation

masayag
Copy link
Collaborator

@masayag masayag commented May 9, 2023

What this PR does / why we need it:
We'd like to make sure our code base is aligned with its conventions.

Which issue(s) this PR fixes :
Fixes #FLPATH-347

Change type

  • New feature
  • Bug fix
  • Unit tests
  • Integration tests
  • CI
  • Documentation
  • Auto generated SDK code

Impacted services

  • Workflow Service
  • Notification Service

Checklist

  • Subject and description added to both, commit and PR.
  • Relevant issues have been referenced.

@masayag
Copy link
Collaborator Author

masayag commented May 9, 2023

This PR is going to heavily fail since our code base doesn't entirely match the convention of spring.
For that, we'll have to disable the rules and gradually add them when fixed.
I suggest enabling the checkstyle plugin per module to make the work sustainable and not too overwhelming.
I'll introduce a set of rules to be excluded in next commits of this PR.

Signed-off-by: Moti Asayag <masayag@redhat.com>
Signed-off-by: Moti Asayag <masayag@redhat.com>
nor System.out.println

Signed-off-by: Moti Asayag <masayag@redhat.com>
Signed-off-by: Moti Asayag <masayag@redhat.com>
Signed-off-by: Moti Asayag <masayag@redhat.com>
Signed-off-by: Moti Asayag <masayag@redhat.com>
Signed-off-by: Moti Asayag <masayag@redhat.com>
Signed-off-by: Moti Asayag <masayag@redhat.com>
Signed-off-by: Moti Asayag <masayag@redhat.com>
Copy link
Collaborator

@pkliczewski pkliczewski left a comment

Choose a reason for hiding this comment

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

/lgtm

@nirarg
Copy link
Contributor

nirarg commented May 18, 2023

/approve

@openshift-ci
Copy link

openshift-ci bot commented May 18, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: nirarg

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-robot openshift-merge-robot merged commit d7b53a1 into parodos-dev:main May 18, 2023
@gciavarrini
Copy link
Contributor

@masayag may I suggest updating the Makefile target format-files?

@masayag
Copy link
Collaborator Author

masayag commented May 18, 2023

@masayag may I suggest updating the Makefile target format-files?

@gciavarrini as the name and the action suggests - format-files changes the files.
with checkstyle, all can be done is check action, not modify the files. Hence it doesn't fit.

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

Successfully merging this pull request may close these issues.

5 participants