github-plugin icon indicating copy to clipboard operation
github-plugin copied to clipboard

docs(contrib): use consistent bullets and indentation for IDE section

Open agilgur5 opened this issue 7 months ago • 0 comments

Summary

Fix markdownlint issues in the "IDE Configuration" section of the CONTRIBUTING.md regarding the bullet style

Details

  • per markdownlint, use one bullet style and indentation consistently

    • previously used -, *, and +, should only use one (I chose -)
    • previously used both two space and four space indents for sub-bullets, should use one consistently (I chose two space)
    • same as my other PR #402, but this one is specific to one section and with almost no other grammatical or style changes
  • colon (":") instead of comma (",") for each IDE

    • this is already done for the sub-bullet sections, but was different/inconsistent for the top-level bullets

Testing done

Submitter checklist

  • [x] Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
  • [x] Ensure that the pull request title represents the desired changelog entry
  • [x] Please describe what you did
  • [x] Link to relevant issues in GitHub or Jira
  • [x] 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

agilgur5 avatar Apr 26 '25 18:04 agilgur5