Skip to content

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

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

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
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.

1 participant