Repository navigation
unneded "." in pull-requests.md file #45502
Description
Activity
It's unclear to me if all items should end with a colon, or if no items should end with a colon. I agree that the lack of consistency is odd though.
Refs: https://learn.microsoft.com/en-us/style-guide/scannable-content/lists#punctuation
/cc @nodejs/documentation @Trott
I found a particular article mentioning this:
Use a period after bullet list that completes the opening stem sentence that introduces it. Don't use a period after bullet lists that are not complete sentences or do not complete the opening stem sentence.
It's unclear to me if all items should end with a colon, or if no items should end with a colon. I agree that the lack of consistency is odd though.
Refs: https://learn.microsoft.com/en-us/style-guide/scannable-content/lists#punctuation
/cc @nodejs/documentation @Trott
In this case, I would propose one of the following:
-
Remove the list content entirely. It's not needed.
-
Convert the list content into a sentence.
Most pull requests in Node.js include changes to the C++ code in the `src` directory, the JavaScript code in the `lib` directory, documentation in the `doc/api` directory, and/or test in the `test` directory.
- Rewrite the sentence fragment introducing the list.
Pull requests in Node.js typically involve changes to one or more of a few places in the code base. * C/C++ code contained in the `src` directory * JavaScript code contained in the `lib` directory * Documentation in `doc/api` * Tests within the `test` directory
-
- added a commit that references this issue
on Nov 19, 2022 - added a commit that references this issue
on Nov 19, 2022 - added a commit that references this issue
on Nov 21, 2022
Version
1af63a9
Platform
github
Subsystem
node/doc/contributing/pull-requests.md
What steps will reproduce the bug?
Intro:
Open the main branch, commit 1af63a9 of nodejs/node
File pull-requests.md
Bug:
There is an unneeded "." in the end of the "tests within the test directory." line.
How often does it reproduce? Is there a required condition?
No response
What is the expected behavior?
No response
What do you see instead?
Additional information
I suggest this bug is marked with "good first time issue" so a new joiner could fix it.