Skip to content

Conversation

agilgur5
Copy link
Contributor

@agilgur5 agilgur5 commented Apr 26, 2025

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 docs(contrib): fix various grammar errors and markdownlint issues #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

  • 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
  • Link to relevant issues in GitHub or Jira
  • 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

- 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, but this one is specific to one section and with almost no other grammatical or style changes

- colon (":") instead of comma (",") for each IDE
@agilgur5 agilgur5 requested a review from a team as a code owner April 26, 2025 18:04
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