docs(contrib): fix various grammar errors and markdownlint issues#402
Merged
KostyaSha merged 1 commit intojenkinsci:masterfrom Nov 3, 2025
Merged
docs(contrib): fix various grammar errors and markdownlint issues#402KostyaSha merged 1 commit intojenkinsci:masterfrom
markdownlint issues#402KostyaSha merged 1 commit intojenkinsci:masterfrom
Conversation
grammar: - "lot of people" -> "many people" - unneeded "the" before "backward compatibility" - "shall" -> "should" - missing comma "," after various prepositions - fix run-on sentence in `volatile` style - etc `markdownlint` issues: - add syntax highlighting to Java codeblock example - consistently use `-` instead of `*` or `+` - all three were used before, only one should be used consistently - consistently use two space indentation for sub-bullets - sometimes it was two space, other times it was four space - etc
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
There were many grammatical issues in the
CONTRIBUTING.mdthat I noticed and have fixed in this PR. There are also manymarkdownlintissues, many of which I fixed in this PRDetails
grammar:
volatilestylemarkdownlintissues:-instead of*or+Misc Notes
I was reading through the Contributing guidelines before submitting #404 and noticed some grammatical and other issues in this docs page, so thought I'd fix and improve them while I'm here
Testing done
markdownlintgives significantly less issues now -- all the lines covered in this PR no longer have errorsSubmitter checklist