Issue #18518: fixed grammar and punctuation#18899
Conversation
b5d5057 to
da0f2e7
Compare
There was a problem hiding this comment.
Pull request overview
Updates the contributor documentation for Checkstyle testing techniques to improve readability for new contributors by correcting grammar, punctuation, and minor phrasing issues.
Changes:
- Refined wording in the TDD section for clearer explanations.
- Improved sentence structure and articles/spacing throughout the guide.
- Tweaked phrasing in the BDD/input-file structure sections for better flow.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - At this moment, Checkstyle uses jdk 21 as its operating version, and all input files that can | ||
| be compiled at jdk 21 or older go to `resources`, while those input files that require newer | ||
| be compiled with jdk 21 or older go to `resources`, while those input files that require newer | ||
| versions of jdk to compile go to `resources-noncompilable`. |
There was a problem hiding this comment.
This section uses "jdk" in running text ("jdk 21", "versions of jdk"). Elsewhere in the repo the convention is "JDK" (e.g., src/site/xdoc/beginning_development.xml). Please update these occurrences here for consistency and readability.
| This **Test Driven Development** technique with collaboration of debug fits well for solving | ||
| various module problems from corresponding issues that give you already prepared information for | ||
| creating the input file and the test to solve that problem. | ||
| This **Test Driven Development** technique with collaboration with the debug fits well for |
There was a problem hiding this comment.
The phrase "with collaboration with the debug" is ungrammatical/unclear. Consider rephrasing to something like "in collaboration with the debugger" or "combined with debugging" so the sentence reads cleanly.
| This **Test Driven Development** technique with collaboration with the debug fits well for | |
| This **Test Driven Development** technique, combined with debugging, fits well for |
| of the tests for a certain module | ||
| - The Name format for such collection files is: `[ModuleClassName]Test` where `[...]` indicates | ||
| you paste your own option inside |
There was a problem hiding this comment.
These bullet items read as full sentences but currently lack ending punctuation. Consider adding periods at the end of the items (e.g., after "module" and "inside") for consistent punctuation with the other lists in this document.
| of the tests for a certain module | |
| - The Name format for such collection files is: `[ModuleClassName]Test` where `[...]` indicates | |
| you paste your own option inside | |
| of the tests for a certain module. | |
| - The Name format for such collection files is: `[ModuleClassName]Test` where `[...]` indicates | |
| you paste your own option inside. |
| Next after config comes the rest of the Java source code that serves the **during** state of | ||
| input file's BDD. This is the intended piece to be tested and to be covered by the running test's | ||
| scope. | ||
| Next after the config comes the rest of the Java source code that serves as the **during** state |
There was a problem hiding this comment.
"Next after the config" is awkward/unnatural phrasing. Consider rewording to "After the config comes ..." or "Next comes ..." to improve readability.
| Next after the config comes the rest of the Java source code that serves as the **during** state | |
| After the config comes the rest of the Java source code that serves as the **during** state |
| - Name format for such collection files is: `[ModuleClassName]Test` where `[...]` indicates you | ||
| paste your own option inside | ||
| of the tests for a certain module | ||
| - The Name format for such collection files is: `[ModuleClassName]Test` where `[...]` indicates |
There was a problem hiding this comment.
In this list item, "The Name format" has incorrect capitalization and reads awkwardly. Consider changing it to "The name format ..." (or just "Name format ...") to match standard sentence case.
| - The Name format for such collection files is: `[ModuleClassName]Test` where `[...]` indicates | |
| - The name format for such collection files is: `[ModuleClassName]Test` where `[...]` indicates |
|
@romani please review |
|
@romani could you let me know some issues that I can solve? I am aiming for GSOC'26 therefore I would really appreciate your guidance |
|
Increase complexity of fixes, stay away from simple updates like this |
fixes #18518
All grammar and punctuation improvements have been completed, making the document more professional and easier to read for new contributors.