unneded "." in pull-requests.md file #45502

Activity

1. aduh95 commented on Nov 18, 2022

   

   aduh95

   on Nov 18, 2022

   Contributor

   More actions

   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
2. anonrig commented on Nov 18, 2022

   

   anonrig

   on Nov 18, 2022

   Member

   More actions

   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.
3. Trott commented on Nov 19, 2022

   

   Trott

   on Nov 19, 2022

   Member

   More actions

   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:

   1. Remove the list content entirely. It's not needed.

   2. 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.

   3. 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
4. Trott

   added a commit that references this issue on Nov 19, 2022

   test: revise pull request guide text about code

   ...

   27e92a0
5. Trott commented on Nov 19, 2022

   

   Trott

   on Nov 19, 2022

   Member

   More actions

   I did option 3 in #45519.
6. nodejs-github-bot

   closed this as completedin #45519on Nov 19, 2022
7. nodejs-github-bot

   added a commit that references this issue on Nov 19, 2022

   test: revise pull request guide text about code

   ...

   5af2021
8. ruyadorno

   added a commit that references this issue on Nov 21, 2022

   test: revise pull request guide text about code

   ...

   c9ba0b7