Skip to content

Google Summer Of Code 2016 Checkstyle Registration Info

Roman Ivanov edited this page Feb 15, 2016 · 1 revision

Organization Profile

Website URL

http://checkstyle.sourceforge.net/

Tagline

Tool to help programmers write Java code that adheres to a coding standard.

Primary Open Source License

LGPL v 2.1

Organization Category

Programming Languages and Development Tool

Technology Tags

Java, antlr

Topic Tags

java development tool, static code analysis, coding standards, coding conventions

Ideas List

https://github.com/checkstyle/checkstyle/wiki/Checkstyle-GSoC-2016-Project-Ideas

Short Description

Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard.

Long Description

Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. It automates the process of checking Java code to spare humans of this boring (but important) task. This makes it ideal for projects that want to enforce a coding standard.

Application Instructions

  1. We make a preference to students that already know our code. It is never too late to start cooperation/contribution to Checkstyle .
  2. Choose one more project
  3. Describe your skills (CV format), by special paragraph list implemented issues in Checkstyle issue tracker that are fixed by you.
  4. Propose a solution for a project with a plan and draft time estimation

Proposal Tags

new feature, optimization, analysis

IRC Channel

http://webchat.freenode.net/?channels=#sevntu.checkstyle

Mailing List

https://groups.google.com/forum/#!forum/checkstyle-devel

General Email

[email protected]

Google+ URL (optional)

https://plus.google.com/108692338295483568100

Twitter URL (optional)

https://twitter.com/checkstyle_java

Application

Why does your org want to participate in Google Summer of Code?

Our main goal is to involve students in development of Open Source, show them that the best approach to gain deep knowledge of programming language is by participating in development of static code analysis. We aim to instill habit to write easy-to-read code by sharing knowledge of best practices in software development while extending Checkstyle with new modules that catch bad practices. Our team has had difficulty keeping constant interest within diligent students in our organization, as students always tend to find a paid job during their summer break instead of volunteering. But even without competitive financial encouragement, we manage to keep students working with us on small features mainly, by offering real-life practical experience and knowledge. We would like to increase speed of task implementation. With Google's financial encouragement we could let students spend the whole summer focusing on big and complicated tasks that are in high demand for Java community.

How many potential mentors have agreed to mentor this year?

1-5

How will you keep mentors engaged with their students?

Current developers of Checkstyle will be mentors for students. They are already agreed to work with students. I, as administrator, will help all students too. Back-up administrator can play a backup mentor role as well.

How will you help your students stay on schedule to complete their projects?

  1. we do not have private e-mail communication all communications are done at open platform (in our mail-list).
  2. students will report to mentors twice a week about their status/achievements, they will have to do each day of “push” to repository to avoid loss of sources. Their remote repositories will be published in mail-list. If progress on project is not as quick as desirable, we switch student to each day report or even twice a day to let mentors from different time zones do code-review after report and promptly give feedback.
  3. we will exchange cell phone numbers with students and additional emails to have more options to be in touch.

How will you get your students involved in your community during GSoC?

We have a number of wiki-like pages that are helpful to start development. All our developers/mentors have experience in working with student for several years.

During practicing in our project students will get experience in cooperating with mentors by discussing tasks that they need to resolve, think beyond the task description and initiate discussion if non clear aspect of implementation appears. We will focus their attention on automation of testing, writing documentation and reporting results to mentors. This would give students the same experience as if they worked at a software company.

We are never satisfied if the module just works. We always discuss nuances of Java language and demand deep understanding from students of what they are writing about, and the quality of code is always a primary concern for us. We will do detailed code review each time students are ready for review and show them ways how to improve code.

How will you keep students involved with your community after GSoC?

During the practice we will explain why clean code and our project matter and how they can be used in development process at any company to ensure stability and quality of work. During development of some validation rules or any other task in our project they will start to feel difference between messy code and easy-to-read one. The more they practice the more it becomes a part of their philosophy and the way of thinking. All their achievements do not have expiration date and could be used at any work place at any time. Students never waste their time on short-lived tasks. Students do tasks for their personal interests and for their future professional needs.

Once they gain this knowledge of clean and coherent coding they will never tolerate messy coding of their colleagues. They will come back to Checkstyle (what they are already do) to extend it with new messy code detecting modules.

Has your org been accepted as a mentoring org in Google Summer of Code before?

YES

Which years did your org participate in GSoC?

2014

What is your success/fail rate per year?

year 2014 - 3/0 , 3 projects was proposed, 3 projects were done.

If your org has applied for GSoC before but not been accepted, select the years:

2015

Are you part of a foundation/umbrella organization?

NO

What year was your project started?

2001

Clone this wiki locally