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

Code quality improvement #17

Closed
charlesdaniels opened this issue Oct 14, 2017 · 1 comment
Closed

Code quality improvement #17

charlesdaniels opened this issue Oct 14, 2017 · 1 comment

Comments

@charlesdaniels
Copy link
Contributor

Once PR #16 is merged, Recaf will have FindBugs and CheckStyle code-quality metrics as part of the reports in mvn site. I would propose a few things to act on these going forward:

  1. Commit to "ratcheting down" the number of quality issues. I would simply record the number of issues associated with each commit and try to reduce it, or at least not increase it, with every commit.

  2. Make an ongoing effort to reduce the number of quality issues, even if it's just a few at a time.

  3. If necessary, disable certain checks from CheckStyle and FindBugs. Not every check will be useful for every project. That said, be sure when disabling a check project-wide that it really isn't a legitimate quality issue for this project.

  4. Once the total issue count is reduced to 0, make CheckStyle and FindBugs part of mvn compile so that the build fails if any new issues appear.

I would suggest creating issues based on the content of this one, then closing this one, as this is just intended to provoke discussion/planning.

@Col-E
Copy link
Owner

Col-E commented Jan 17, 2020

Currently using a more lenient version of Google's Java config for CheckStyle.
FindBugs / SpotBugs is there, but not required for building.

@Col-E Col-E closed this as completed Jan 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants