10000 docs(contrib): use consistent bullets and indentation for IDE section by agilgur5 · Pull Request #403 · jenkinsci/github-plugin · GitHub
[go: up one dir, main page]
Skip to content

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

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.

Sign up for GitHub

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

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

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

wants to merge 1 commit into from

Conversation

agilgur5
Copy link
Contributor
@agilgur5 agilgur5 commented Apr 26, 2025 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

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

@agilgur5
docs(contrib): use consistent bullets and indentation for IDE section
02e3eca 
- 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
@agilgur5 agilgur5 mentioned this pull request May 17, 2025
Open
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@agilgur5
0