JanusGraph / JanusGraph/janusgraph
Introduce checkstyle (or similar) plugin and make it part of CI pipeline
- Dominant language
- Java
- Stars
- 5.8k
- Forks
- 1.2k
- Avg merge
- 13h 53m
- Merged PRs (30d)
- 6
Description
I think the majority of small code review comments could be avoided if we had strict style checking as part of the build. It would also keep the code consistent. I suggest we introduce checkstyle, take an initial hit on having to reformat/update some code and live happily ever after.
Things checkstyle should enforce (lets update this list as cleanup continues):
- [ ] redundant access modifiers in interfaces
- [ ] four-space indentation
- [ ] diamond for templates on the right hand side of assignments
- [ ] final modifier
- [ ] line length
Contributor guide
Research direction
Start by inspecting the project's build and CI configuration to find where a Checkstyle or similar plugin would be integrated. Review the requested rules—interface access modifiers, four-space indentation, diamond operators, final modifiers, and line length—and determine the existing cleanup scope. Done means the checks run in CI and the initial violations are resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- build-system, ci-cd, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100