
Helps to adheres of Java coding standard
Showing 5 of 27 projects. Click any project card for scope, mentors, and proposal studio.
Mentors: Student: Gianmarco Schifone
Description: Project will mainly be focusing on automation of Documentation Comments (javadoc) guidelines by Checkstyle Checks. Reliable comments parsing was a major improvement in Checkstyle during GSoC 2014 and 2025, archived results need to be reused to reliably implement automation of Javadoc best practices. Separate configuration file with newly created Checks need to be created. Best practices in documentation make sense not for all projects. Javadoc validation matters only for library projects that need to expose online documentation in web publicly. Deliverables: The result of this project will be a configuration file with the maximum possible coverage of Comment style guide. Report should look like Google's Java Style Checkstyle Coverage. If there will be time left we can focus on coverage of guidelines from https://blog.joda.org/2012/11/javadoc-coding-standards.html
Mentors: Student: Smita Prajapati
This project aims to improve the quality, consistency, and usability of the Checkstyle documentation website by enhancing automation and user experience. Although documentation generation has been partially automated from Java sources, gaps still exist such as missing examples, inconsistent formatting, and difficulty in navigation. The project will focus on completing and standardizing documentation for all Checkstyle modules by adding missing examples and enforcing uniform formats through automated validation integrated into the build and CI pipeline. This will reduce manual effort and ensure documentation remains accurate and up-to-date. Additionally, the website’s usability will be improved through frontend enhancements, including a client-side search feature based on a pre-generated index, enabling fast and backend-free navigation across the static site. Existing user-reported issues will also be addressed to further enhance the overall experience. Deliverables include: 1. Adding missing examples for all Checkstyle modules and checks 2. Standardizing and validating documentation formats across the website 3. Automating documentation checks within the CI/build pipeline 4. Implementing a client-side search feature for improved navigation 5. Resolving existing website usability issues and improving UX 6. Providing clear documentation for contributors on maintaining content
Mentors: Student: Monu Chaudhary
Checkstyle plays an important role in maintaining code quality in Java projects, but many of its reported violations are small, repetitive issues that developers tend to overlook. Although these problems are easy to fix, the effort required to manually locate and resolve each one discourages developers from addressing them, resulting in inconsistent code quality and growing technical debt. This project focuses on reducing that manual overhead by extending Checkstyle’s auto-fix capabilities using OpenRewrite. The main objective is to develop auto-fix recipes targeting frequently occurring Checkstyle violations. These recipes will automatically apply safe and consistent transformations to the codebase, allowing developers to resolve issues quickly and at scale. Beyond adding new recipes, the project will improve the internal design of the auto-fix system by transitioning from a position-based approach to a marker-based approach. The current method relies heavily on fixed code positions, which can become unreliable when the code structure changes. A marker-based strategy, on the other hand, enables more stable and context-aware transformations, making the system easier to maintain and extend. All implemented recipes will follow consistent design principles, include proper test coverage, and be validated on real-world open-source projects to ensure their correctness and effectiveness in practical scenarios. Overall, this project aims to streamline the process of fixing style violations, improve developer efficiency, and strengthen Checkstyle’s ecosystem by making automated code corrections more reliable and scalable.
Mentors: Student: Aman Baliyan
This project aims to enhance Checkstyle by providing complete and up-to-date support for the OpenJDK Code Convention and the emerging OpenJDK Java Style Guidelines. The current implementation, based on the outdated sun_checks.xml configuration from 2004, lacks coverage for many modern rules and newly introduced Checkstyle modules. This project will systematically review both old and new guidelines, implement missing checks, refine existing configurations, and resolve known issues. The goal is to make OpenJDK coding conventions fully enforceable within Checkstyle, improving code quality and developer experience. Key deliverables include updating configurations, adding new modules where required, improving test coverage, and creating detailed documentation to clearly represent rule coverage and support levels.
Mentors: Student: Atharv Chavan
I will resolve all false negatives present in the modules (checks) used in the Google Style Guide coverage. I will also identify and fix issues related to the modules used for coverage. Additionally, I will address blocking bugs and update the coverage page for the Google Style Guide.