FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: add note regarding file structure in src/README.md by lundibundi · Pull Request #35000 · nodejs/node · GitHub

/ node Public

doc: add note regarding file structure in src/README.md - #35000

Closed
lundibundi wants to merge 1 commit into
nodejs:masterfrom
lundibundi:improve-cpp-readme
ConversationCommits (1)ChecksFiles changed
Closed

doc: add note regarding file structure in src/README.md#35000
lundibundi wants to merge 1 commit into
nodejs:masterfrom
lundibundi:improve-cpp-readme

Conversation

lundibundi commented Aug 31, 2020

Copy link
Copy Markdown
Member

Refs: #34944 (comment)

Mostly adapted from @addaleax comment (I hope you don't mind) on the files structure since this information seems to be missing from our guides and it would be helpful for people unfamiliar/new with C++.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

/cc @nodejs/documentation @Trott

doc: add note regarding file structure in src/README.md
7bca690 
Refs: nodejs#34944 (comment)
Co-authored-by: Anna Henningsen <anna@addaleax.net>
lundibundi added doc Issues and PRs related to the documentations. request-ci Add this label to start a Jenkins CI on a PR. labels Aug 31, 2020
lundibundi requested a review from addaleax August 31, 2020 20:35
nodejs-github-bot added the c++ Issues and PRs that require attention from people who are familiar with C++. label Aug 31, 2020
github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 31, 2020

nodejs-github-bot commented Aug 31, 2020

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/32987/

addaleax approved these changes Aug 31, 2020
View reviewed changes

addaleax left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

The text sounds good, but since it’s a stylistic question, maybe rather add it to the style guide?

juanarbol approved these changes Aug 31, 2020
View reviewed changes

juanarbol left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM

lundibundi commented Sep 1, 2020

Copy link
Copy Markdown
Member Author

@addaleax I'm not sure, I can move it there but personally I'd not expect the info regarding files structure to be in the style guide. Though looking at it right now it already has Do not include *.h if *-inl.h has already been included and other not really stylistic but general advice. So I guess it will be fine to have it there in the Other section? (my main concern is that it won't be as "visible" there compared to this file)

lundibundi commented Sep 14, 2020

Copy link
Copy Markdown
Member Author

ping @addaleax @nodejs/documentation, wdyt #35000 (comment)?

addaleax commented Sep 15, 2020

Copy link
Copy Markdown
Member

@lundibundi I don’t have any strong opinions there, feel free to go with what you think is right :)

aduh95 added author ready PRs that have at least one approval, no outstanding review comments, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Nov 8, 2020

aduh95 commented Nov 9, 2020

Copy link
Copy Markdown
Contributor

Landed in da3626a

aduh95 pushed a commit that referenced this pull request Nov 9, 2020
doc: add note regarding file structure in src/README.md
da3626a 
Refs: #34944 (comment)
Co-authored-by: Anna Henningsen <anna@addaleax.net>

PR-URL: #35000
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
aduh95 closed this Nov 9, 2020
danielleadams pushed a commit that referenced this pull request Nov 9, 2020
doc: add note regarding file structure in src/README.md
71fa9c6 
Refs: #34944 (comment)
Co-authored-by: Anna Henningsen <anna@addaleax.net>

PR-URL: #35000
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
danielleadams mentioned this pull request Nov 9, 2020
Merged
BethGriggs pushed a commit that referenced this pull request Dec 9, 2020
doc: add note regarding file structure in src/README.md
68fc4ed 
Refs: #34944 (comment)
Co-authored-by: Anna Henningsen <anna@addaleax.net>

PR-URL: #35000
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
BethGriggs pushed a commit that referenced this pull request Dec 10, 2020
doc: add note regarding file structure in src/README.md
a3d5a69 
Refs: #34944 (comment)
Co-authored-by: Anna Henningsen <anna@addaleax.net>

PR-URL: #35000
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
BethGriggs mentioned this pull request Dec 10, 2020
Merged
BethGriggs pushed a commit that referenced this pull request Dec 15, 2020
doc: add note regarding file structure in src/README.md
30cd797 
Refs: #34944 (comment)
Co-authored-by: Anna Henningsen <anna@addaleax.net>

PR-URL: #35000
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
panva removed the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 27, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

addaleax addaleax approved these changes
gireeshpunathil gireeshpunathil approved these changes
juanarbol juanarbol approved these changes
+1 more reviewer
aymen94 aymen94 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. c++ Issues and PRs that require attention from people who are familiar with C++. doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

Back | FazBrowse Home | New Git URL