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
doc: improve grammar, spelling, and punctuation #14730
Open
AdoraMel
wants to merge
1
commit into
checkstyle:master
Choose a base branch
from
AdoraMel:docs
base: master
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -55,20 +55,21 @@ | |||||
<section name="Report an issue"> | ||||||
|
||||||
<p> | ||||||
All functional changes in project should have registered issue and wide explanation in it. | ||||||
Issue number has to be referenced in git commit message, see format below. | ||||||
All functional changes in the project should have a registered issue and detailed | ||||||
explanation in it. The Issue number has to be referenced in the git commit message, | ||||||
see format below. | ||||||
</p> | ||||||
|
||||||
<p> | ||||||
To report issue please follow our best practices page - <a href="report_issue.html"> | ||||||
To report an issue please follow our best practices page - <a href="report_issue.html"> | ||||||
How to report an issue?</a> (<a href="report_issue.html#How_to_report_a_bug.3F"> | ||||||
How to report a bug?</a>) | ||||||
</p> | ||||||
</section> | ||||||
|
||||||
<section name="Build"> | ||||||
<p> | ||||||
Project is following general maven layout and phases for build. | ||||||
The project is following a general maven layout and phases for its build. | ||||||
Generated jars will be in folder <code>target</code>. | ||||||
</p> | ||||||
|
||||||
|
@@ -87,8 +88,8 @@ | |||||
<section name="Quality matters"> | ||||||
|
||||||
<p> | ||||||
The developer team of checkstyle is really a lazy bunch of | ||||||
people. We try to avoid work as best as we can, but most of all | ||||||
The developer team of checkstyle is a really lazy bunch of | ||||||
people. We try to avoid work as best as we can, but most of all | ||||||
we try to avoid working on bugs that are reported by end users. | ||||||
</p> | ||||||
|
||||||
|
@@ -107,7 +108,7 @@ | |||||
<br/> | ||||||
<code>mvn test jacoco:restore-instrumented-classes jacoco:report@default-report</code>. | ||||||
<br/> | ||||||
Check results on report target/site/jacoco/index.html in project home folder. | ||||||
Check the results on the report in target/site/jacoco/index.html in project home folder. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
</p> | ||||||
|
||||||
<p> | ||||||
|
@@ -127,7 +128,7 @@ | |||||
</p> | ||||||
|
||||||
<p> | ||||||
The last step of verification that all works fine please do testing of your | ||||||
For the last step of verification, so that everything works fine, please do testing of your | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
functionality on any open-source project (Spring, Hibernate, ....). | ||||||
Here is how to do it by | ||||||
<a href= | ||||||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section has bothered me for some time @rnveach @romani can we get rid of this historical artifact?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will not comment on how accurate this statement is, but I feel offended by it. I am good to not see it again.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, let’s remove it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am ok to remove