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
Please, add a small section to the README on how to install and use this tool #14838
Comments
If we added a link, it would probably point to https://checkstyle.org/beginning_development.html |
I agree with these statements, and I am actively working on a PR to improve this situation by adding a "quick start" section to the README: #14514. Thanks for raising this issue.
Yes, I mostly agree with this statement; the badges are distracting, and not really helpful to most users. However, this seems to be a fairly common Github practice, and easily ignored. |
Historically users used https://checkstyle.org/ more than source hosting services. But GitHub changed this, and even Google search direct to source repo above website.
For just usage better |
Most projects (especially projects targeted at developers) have usage information as the first element of their README, and I wholeheartedly agree with this practice. However, this is sort of a complicated topic for us. Most folks will use checkstyle via gradle or maven plugins, which we do not maintain. I am not sure how I would feel about having the typical copy/pastable module in our README for gradle and maven dependencies since we have no control over these projects. |
We can ask users what they expect while reading GitHub Readme. |
The most important thing is not in the README. I want to start using this tool, but I am spammed with all these badges, and there are no instructions on how to install and use this tool, but just links and confusing texts. Yes, I know there's the documentation, but why not also have some useful instructions directly on the README on how to do what I said?
The text was updated successfully, but these errors were encountered: