Skip to content

docs(contrib): fix various grammar errors and markdownlint issues#402

Merged
KostyaSha merged 1 commit intojenkinsci:masterfrom
agilgur5:docs-grammar
Nov 3, 2025
Merged

docs(contrib): fix various grammar errors and markdownlint issues#402
KostyaSha merged 1 commit intojenkinsci:masterfrom
agilgur5:docs-grammar

Conversation

@agilgur5
Copy link
Contributor

@agilgur5 agilgur5 commented Apr 26, 2025

Summary

There were many grammatical issues in the CONTRIBUTING.md that I noticed and have fixed in this PR. There are also many markdownlint issues, many of which I fixed in this PR

Details

grammar:

  • "lot of people" -> "many people"
  • incorrect "the" before "backward compatibility", which is not a specific noun
  • "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

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

Submitter checklist

  • Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
  • Ensure that the pull request title represents the desired changelog entry
  • Please describe what you did
  • [n/a] Link to relevant issues in GitHub or Jira
  • [n/a] Link to relevant pull requests, esp. upstream and downstream changes
  • [n/a] Ensure you have provided tests - that demonstrates feature works or fixes the issue

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
@agilgur5 agilgur5 requested a review from a team as a code owner April 26, 2025 18:01
@KostyaSha KostyaSha merged commit 50b47dd into jenkinsci:master Nov 3, 2025
17 checks passed
@agilgur5 agilgur5 deleted the docs-grammar branch November 4, 2025 00:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants