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

Refactor Layered Architecture #2976

Open
iluwatar opened this issue Jun 1, 2024 · 7 comments
Open

Refactor Layered Architecture #2976

iluwatar opened this issue Jun 1, 2024 · 7 comments

Comments

@iluwatar
Copy link
Owner

iluwatar commented Jun 1, 2024

Description

Layered Architecture example has some code smells.

CakeInfo - 'Optional' used as type for field 'id'
CakeLayerInfo - 'Optional' used as type for field 'id'
CakeToppingInfo - 'Optional' used as type for field 'id'

Acceptance Criteria

  • Code smells fixed
@ankurnotwarikoo
Copy link

Willing to work on this.
However in my sts I am unable to see the code smells as such. Followed the instructions mentioned here :-
https://github.com/iluwatar/java-design-patterns/wiki/12.-IDE-instructions

image
Could only see identation issues as such.
Please let me know how do I proceed to resolve this.
P.S. - Interested to contribute to this repo !

@iluwatar
Copy link
Owner Author

iluwatar commented Jun 4, 2024

Don't know about other IDEs, but in IntelliJ IDEA you can reproduce the warnings by using command 'Analyze - Inspect Code' on the layered-architecture module.

@ankurnotwarikoo
Copy link

Could you assign this issue to me? This is my first time contributing, so I also need some guidance on how to commit and raise a pull request. Thank you!

@iluwatar
Copy link
Owner Author

iluwatar commented Jun 4, 2024

Sure @ankurnotwarikoo Here are a couple of good starting points to get started with Github and this project:

@ankurnotwarikoo
Copy link

@iluwatar - I am done with the code fixes. However, format the code using checkstlye plugin in Intellij and hence unable to surpass the validation of code.
Do let me know if there's some checkstyle.xml on which defines the basis of formatting of file.

@iluwatar
Copy link
Owner Author

iluwatar commented Jun 6, 2024

Checkstyle is configured here: https://github.com/iluwatar/java-design-patterns/blob/master/pom.xml#L334-L356

It uses built-in Google Checks. We have added some of our own rule suppressions.

IDE instructions have some hints on how to work with Checkstyle https://github.com/iluwatar/java-design-patterns/wiki/12.-IDE-instructions

@iluwatar
Copy link
Owner Author

iluwatar commented Jun 6, 2024

Noticed that we have a partly duplicate issue #2936

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Development

No branches or pull requests

2 participants