doc: add glossary.md #27517
doc: add glossary.md #27517
Conversation
|
Some of these terms are already defined in the linked Chromium glossary. |
|
Can you move this under |
I do it deliberately because LGTM is too common. |
My thought is that it's very basic doc, so I would like to be in the root directory. |
|
Do we need to add |
If we add a glossary, I'd say it should contain references to all acronyms we use.
I am on the edge about this. I see the benefit of having in the root dir but we already have to many files in there (we might want to move some other files like the CPP style guide. That does not seem to belong into the root dir. The collaborator guide could likely also be moved since it's intention is mainly for collaborators and not for everyone).
Those are pristine built-ins that are not effected by prototype pollution and tampering with built-ins. |
My intuition is that this should be in https://github.com/nodejs/node/blob/master/COLLABORATOR_GUIDE.md (prbly at the end) |
|
Some more terms that come to mind, esp. when in the context of Node.js
|
Add links to this PR: #26929 ? This is very a good idea. I wonder what we can do to get more people contribute to Node.js. @joyeecheung recently write a ppt, which is very good to read (Written in Chinese): https://github.com/joyeecheung/talks/blob/master/code_and_learn_2019_beijing/contributing-to-node-core.pdf. |
|
Not sure this needs to be in a separate document at the top level. This can be added as a section of the contributor guide. |
It's more clear when it in one file such as chrome did. |
FROM #27246 (review) So what's OOB and WAT ? Should we add those two. cc @joyeecheung |
Now sorted. (Using vim |
I'd avoid adding that (and, probably, a glossary at all, to be honest, but I won't block if others think this is a good idea). These terms are not Node.js-specific. People can use search engines and/or we can link to a general glossary that has these sorts of things. We can't include every piece of information imaginable in our source code, and trying will make the important stuff harder to find. We need to curate our information. (Why not include handler? SIGSEGV? Wasm? Child process? Process? Web server? Test?) Realistically, I suspect people aren't going to look in the glossary anyway. They're going to ask, "What is WAT?" |
|
I guess I'd be more inclined to support this if we either just linked to Chrome's glossary (why duplicate the work?) or held the glossary to be strictly Node.js-specific terms or things very closely tied to Node.js. None of these except maybe |
|
IMO, the ones mentioned in #27517 (comment) are going to be really useful for new comers, irrespective of their sole origin is our project or not, (and in some case how trivial those may look), but those are heavily used across the code and doc. Here are some more:
|
This comment has been minimized.
This comment has been minimized.
gengjiawen
force-pushed
the
glossary
branch
2 times, most recently
from
5161e3e
to
f08236d
Compare
This comment has been minimized.
This comment has been minimized.
gengjiawen
added
the
author ready
This comment has been minimized.
This comment has been minimized.
| @@ -0,0 +1,16 @@ | |||
| You may also need to check https://chromium.googlesource.com/chromiumos/docs/+/master/glossary.md. | |||
There was a problem hiding this comment.
Nit: shouldn't this go at the bottom of the file, as it's meant to be an addition to this file based in the text?
| * PTAL: Please take a look. | ||
| * RSLGTM: "Rubber-stamp looks good to me". The reviewer approving without doing | ||
| a full code review. | ||
| * TSC: Technical Steering Committee. Detailed info see |
There was a problem hiding this comment.
Nit:
| * TSC: Technical Steering Committee. Detailed info see | |
| * TSC: Technical Steering Committee. Detailed info can be found here |
Or
| * TSC: Technical Steering Committee. Detailed info see | |
| * TSC: Technical Steering Committee. For detailed info see |
| * WIP: "Work In Progress" - e.g. a patch that's not finished, but may be worth | ||
| an early look. | ||
| * WPT: [web-platform-tests](https://github.com/web-platform-tests/wpt) | ||
| * godbolt: [Compiler Explorer](https://godbolt.org/) run compilers interactively |
There was a problem hiding this comment.
Nit:
| * godbolt: [Compiler Explorer](https://godbolt.org/) run compilers interactively | |
| * godbolt: [Compiler Explorer](https://godbolt.org/) allows to run compilers interactively |
PR-URL: #27517 Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Denys Otrishko <[email protected]>
|
Landed in 13c05cd |
|
@lundibundi I will open a pr to resolve this and add more items. |
PR-URL: #27517 Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Denys Otrishko <[email protected]>
PR-URL: #27517 Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Denys Otrishko <[email protected]>
PR-URL: #27517 Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Denys Otrishko <[email protected]>
PR-URL: #27517 Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Denys Otrishko <[email protected]>
Related issue: #26718.
Todo
I want to add
primordials, but I have no idea what it means.cc @refack @BridgeAR
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes