Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. By default it supports the Google Java Style Guide and Sun Code Conventions, but is highly configurable. It can be invoked with an ANT task and a command line program.
@CapTen101 Please look over https://checkstyle.sourceforge.io/beginning_development.html . afterwards you can choose issue from https://github.com/checkstyle/checkstyle/labels/gsoc%20first%20issue that is not pre-assigned yet. You just need to say "I am on it" to take on the issue so no one else will try to take it from you.
Since there were no coding issues available in gsoc label , I have picked up #7476 issue (it is not a gsoc labelled issue: Hope it is okay ) . I have commented " i am on it" in the comment section of this issue.
@yajna-pandith Please look over https://github.com/checkstyle/checkstyle/wiki/To-student-of-GSoC-2020 . There are plenty of issues available for the GSoC first timers. See https://github.com/checkstyle/checkstyle/labels/gsoc%20first%20issue
@rnveach I will go through the link. Regarding the issues for GSoC first timers, the issues are either documentation based (I am a little skeptical in choosing documentation issues as these will not outrightly highlight my coding skills ) or the coding issues on which people have commented " I am on it" .
How should i go about from here? Help me .
Thanks in advance.
How should i go about from here? Help me .
Thanks in advance.
There is an easy label which you can use to look at issues we have identified as easy. Some are labeled like that because it is simply or the issue provides details on how to complete the work. If you don't want to try a gsoc one first, then you can try looking at checkstyle/checkstyle#6893 .
Hi guys,
I'm interested in contributing to checkstyle and I'm still following your docs and getting familiar with project.
In this section "https://checkstyle.sourceforge.io/writingchecks.html#Tool_to_print_Java_tree_structure" when trying to execute the command " java -jar checkstyle-5.6-all.jar -t MyClass.java" to print Abstract Syntax Tree, it outputs the following error.
Thanks in advance.
I'm interested in contributing to checkstyle and I'm still following your docs and getting familiar with project.
In this section "https://checkstyle.sourceforge.io/writingchecks.html#Tool_to_print_Java_tree_structure" when trying to execute the command " java -jar checkstyle-5.6-all.jar -t MyClass.java" to print Abstract Syntax Tree, it outputs the following error.
org.apache.commons.cli.UnrecognizedOptionException: Unrecognized option: -t
at org.apache.commons.cli.Parser.processOption(Parser.java:363)
at org.apache.commons.cli.Parser.parse(Parser.java:199)
at org.apache.commons.cli.Parser.parse(Parser.java:85)
at com.puppycrawl.tools.checkstyle.Main.main(Main.java:77) -c <arg> The check configuration file to use.
-f <arg> Sets the output format. (plain|xml). Defaults to plain
-o <arg> Sets the output file. Defaults to stdout
-p <arg> Loads the properties file
-r <arg> Traverse the directory for source files
usage: java com.puppycrawl.tools.checkstyle.Main [options] -c <config.xml> The Checkstyle SDK Gui is working fine with the same .jar used. Any idea to fix this issue!Thanks in advance.
@vibudhvishal Please look over https://github.com/checkstyle/checkstyle/wiki/To-student-of-GSoC-2020 . There are plenty of issues available. See https://github.com/checkstyle/checkstyle/labels/gsoc%20first%20issue
@PrabodDunuwila
checkstyle-5.6-all.jar
Why are you using such an extremely old version? We are on 8.29 . The option probably didn't exist back then.
Hello everyone, I am Ritvij Kumar Sharma and I am an Android developer and hence experienced with java. I look forward to taking part in GSOC 2020 and contributing to CheckStyle. This is my Github account https://github.com/ritvij14
I have already gone through this link https://github.com/checkstyle/checkstyle/wiki/To-student-of-GSoC-2020
and will start with an easy issue since I am a GSoC first-timer.
I have already gone through this link https://github.com/checkstyle/checkstyle/wiki/To-student-of-GSoC-2020
and will start with an easy issue since I am a GSoC first-timer.
I am facing a problem while importing the maven project. I am working with Eclipse IDE and while importing the project the heap size shows a max of 376 MB and heap keeps increasing but after reaching around 260, it again drops back down to 110. Also, the Importing Maven Projects status at bottom right is stuck at 9%. Does it normally take this long? Or is it some problem with Eclipse? So should I change my IDE?
hello, i've been trying to run checkstyle from the source code for 4 days, i am using intellij on windows and for a reason that i do not understand, intellij does not read any antlr 4 file (javadocParser for ex.) and i cannot run from intellij in order to test any code, is there any advice? i was supposed to start from day 20 :(
Hello!
I am Yuvraj Agrawal currently pursuing B.Tech in CS from Indian Institute of Technology and I am also looking forward to GSOC 2020 and wish to contribute to your organization. I am new to open source development and am currently going through the documentation of checkstyle. Please, assign me some minor bugs or projects to learn your code efficiently.
Thanks
I am Yuvraj Agrawal currently pursuing B.Tech in CS from Indian Institute of Technology and I am also looking forward to GSOC 2020 and wish to contribute to your organization. I am new to open source development and am currently going through the documentation of checkstyle. Please, assign me some minor bugs or projects to learn your code efficiently.
Thanks
Hi @Yuvraj1108 . Please read https://github.com/checkstyle/checkstyle/wiki/To-student-of-GSoC-2020 first. After that pick up any issue from https://github.com/checkstyle/checkstyle/labels/gsoc%20first%20issue and put a comment in the issue "I am on it" and start working
Hi @coraljain, Please read https://github.com/checkstyle/checkstyle/wiki/To-student-of-GSoC-2020 first. After that pick up any issue from https://github.com/checkstyle/checkstyle/labels/gsoc%20first%20issue and put a comment in the issue "I am on it" and start working
Hi, everyone! Is there any resource which explains how to start working on your project? I have read https://github.com/checkstyle/checkstyle/wiki/To-student-of-GSoC-2020 but there is no any information about how can I start dealing with project.
I have read some issues, I understood what should I do, but I don't understand how can I do this :)
Can anybody help, please?
Can anybody help, please?
Hi @MrHakimov did you follow all pages referenced from https://github.com/checkstyle/checkstyle/wiki/To-student-of-GSoC-2020 (like this, for instance, https://checkstyle.sourceforge.io/beginning_development.html) ? Did you choose any issue from https://github.com/checkstyle/checkstyle/labels/gsoc%20first%20issue and follow more references given in issue description (like this, for instance, https://checkstyle.org/cmdline.html) ?
I have read some issues, I understood what should I do, but I don't understand how can I do this
Could you clarify please which issues did you read and what exactly didn't you understand? Each issue from the aforementioned list contains links to example commits which were already applied. I suggest to take a look at those commits, you need to do something similar (like this, for instance, checkstyle/checkstyle#6105).
Thanks for this one: https://checkstyle.sourceforge.io/beginning_development.html! I will choose issue now.
I am so sorry for stupid questions, but I have just done first 4 steps from here:
https://checkstyle.sourceforge.io/beginning_development.html#Starting_Development
and my question is how to check is the things that I add doesn't break anything? Can I somehow deploy checkstyle in my local machine maybe? Please, give some advices. Thanks in advance!
https://checkstyle.sourceforge.io/beginning_development.html#Starting_Development
and my question is how to check is the things that I add doesn't break anything? Can I somehow deploy checkstyle in my local machine maybe? Please, give some advices. Thanks in advance!
Should I follow these commands?
https://checkstyle.org/cmdline.html#Download_and_Run
https://checkstyle.org/cmdline.html#Download_and_Run
@rnveach The result should be something like this one above?
I hope I didn't come too late to the party, there are so many organisations to choose from!
@razvanboboc Please read over https://github.com/checkstyle/checkstyle/wiki/To-student-of-GSoC-2020 first. After that pick up any issue from https://github.com/checkstyle/checkstyle/labels/gsoc%20first%20issue . You can put a comment in the issue "I am on it" and start working on it.
I am currently on issue #7605. I wanted to ask how should I check for correctness of javadoc comments? I have installed the checkstyle plugin directly in Eclipse. Is that the wrong way? Because it does not give me any warnings even though the program that i created had 2 @-clauses in one line.
@ritvij14 To better help we would have to see what config and java code you are using. Please edit your comment in the issue with a template similar to https://checkstyle.org/report_issue.html#How_to_report_a_bug.3F .
From what I read of the check, its violations are about
/** being on the same line or not with */. You can also run the code through the check by modifying one of the tests and it's inputs and debugging the check itself. All checks have tests and inputs for them in the repository
@rnveach I want to apply for GSoC. My PR #7673 has passed all the CI tests. Shall I wait for it to be merged or take up the next issue from easy/medium tag? It would be great if you help me pick one.