Skip to content
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

doc: use <ul> instead of <ol> in SECURITY.md #56346

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

doc: use <ul> instead of <ol> in SECURITY.md #56346

wants to merge 1 commit into from

Conversation

aduh95
Copy link
Contributor

@aduh95 aduh95 commented Dec 23, 2024

The Microsoft style guide says:

Use a numbered list for sequential items (like a procedure) or prioritized items (like a top 10 list).
Use a bulleted list for things that have something in common but don’t need to appear in a particular order.

It seems to me those lists fit much better the latter, and therefor should be bulleted (i.e. <ul>).
If I'm wrong and those lists indicates a prioritization, we should make it explicit.

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Dec 23, 2024
@aduh95 aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 23, 2024
UlisesGascon
UlisesGascon approved these changes Dec 24, 2024
View reviewed changes
Copy link
Member

@UlisesGascon UlisesGascon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc: @nodejs/security-wg

@marco-ippolito marco-ippolito added the commit-queue Add this label to land a pull request using GitHub Actions. label Dec 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marco-ippolito marco-ippolito marco-ippolito approved these changes

@Ayase-252 Ayase-252 Ayase-252 approved these changes

@UlisesGascon UlisesGascon UlisesGascon approved these changes

@lpinca lpinca lpinca approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@aduh95 @nodejs-github-bot @lpinca @UlisesGascon @Ayase-252 @marco-ippolito