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

Enable checkstyle && fix issues in entity/agent #375

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

TedaLIEz
Copy link
Contributor

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Code compiles correctly with all tests are passed.
  • I've read the contributing guide and followed the recommended practices.
  • Wikis or README have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

If this introduces a breaking change for Hydra Lab users and requires a migration process, please describe the impact and migration path for existing applications below.

  • Yes
  • No

Pull Request Description

Enable checkstyle in common module, wave 1

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Build related changes
  • Refactoring (no functional changes, no api changes)
  • Code style update (formatting, renaming) or Documentation content changes
  • Other (please describe):

A few words to explain your changes:

Does this close any currently open issues? Issue ID: #

How you tested it

Please make sure the change is tested, you can test it by adding UTs, do local test and share the screenshots, etc.

Feature UI Screenshots or Technical Design Diagrams

If this is a relatively large or complex change, kick off the discussion by drawing the tech design with PlantUML and explaining why you chose the solution you did and what alternatives you considered, etc...

@TedaLIEz TedaLIEz enabled auto-merge (squash) March 15, 2023 03:17
@@ -33,8 +34,12 @@ public MobileDevice() {

@Override
public boolean equals(Object o) {
if (this == o) return true;
Copy link
Member

Choose a reason for hiding this comment

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

Could we consider allowing this style and disabling this rule entirely? I this the oneliner is quite useful and readable.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We can remove NeedBraces in our checkstyle-ruleset.xml, but I personally don't like non-braces style xD

@hydraxman
Copy link
Member

hydraxman commented Apr 28, 2023

Could you modify the doc contributing guide and provide a list there to list all the enabled rules? Or if there are too many, you may briefly summarise the goal or the recommended coding practices of this change in the doc, and attach some official doc link of checkstyle in the contributing doc to provide clarity. @TedaLIEz

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.

2 participants