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

Lack of code style convention #38

Closed
cesarsotovalero opened this issue Mar 12, 2021 · 3 comments · Fixed by #39
Closed

Lack of code style convention #38

cesarsotovalero opened this issue Mar 12, 2021 · 3 comments · Fixed by #39

Comments

@cesarsotovalero
Copy link
Collaborator

cesarsotovalero commented Mar 12, 2021

Currently, the DepClean codebase lacks proper code style conventions. This makes the codebase messy and is overall bad for maintainability. The best way to mitigate this is by enforcing the use of strict code style rules.

Checkstyle is currently one of the best tools for this purpose. Configuring Checkstyle in DepClean will help newcomers to have a more clean codebase to work with.

@ABHAY0O7
Copy link
Contributor

Hey... @cesarsotovalero,
I would like to work on this enhancement, may I?
And if yes then please also suggest to me some documentation of this repo, because if we use checkstyle for code style conventions then we have to also write incode short documentation of every method, class, and interface. So the documentation will help me a lot in understanding the codebase and also in writing short but effective incode documentation.

@cesarsotovalero
Copy link
Collaborator Author

Hi @ABHAY0O7, Welcome!

I would like to work on this enhancement, may I?

I've already done it. But you can add documentation and fix Checkstyle warnings.

@ABHAY0O7
Copy link
Contributor

ABHAY0O7 commented Mar 15, 2021

Ya sure @cesarsotovalero, I am on it.

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 a pull request may close this issue.

2 participants