Skip to content

Commit 970ca11

Browse files
authored
doc: add more definitions to GLOSSARY.md
1 parent 08c3256 commit 970ca11

File tree

2 files changed

+155
-22
lines changed

2 files changed

+155
-22
lines changed

GLOSSARY.md

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
# Glossary
2+
3+
This file documents various terms and definitions that are used throughout the Node.js community.
4+
5+
* **ABI**: [Application Binary Interface][] - Defines the interface between two binary program modules.
6+
* **AFAICT**: As Far As I Can Tell.
7+
* **AFAIK**: As Far As I Know.
8+
* **API**: [Application Programming Interface][] - A set of rules and protocols that allows different software
9+
applications to communicate with each other. APIs are used to enable integration between different systems.
10+
* **ASAP**: As Soon As Possible.
11+
* **BE**: Big [Endian][] - A Byte Order where the largest bit comes first. The opposite of **LE**.
12+
* **Bootstrap**: Early phase in the Node.js process startup - sets up the execution environment and loads internal
13+
modules.
14+
* **CI**: [Continuous Integration][] - Development practice where code changes are frequently merged into a shared
15+
repository.
16+
* **CITGM**: Canary In The Gold Mine - A smoke test which tests the code change with popular NPM packages.
17+
* **CJS**: [CommonJS][] - Standard for JavaScript modules, and in most cases, [CommonJS Modules][].
18+
* **CLDR**: [Common Locale Data Repository][] - A repository of locale data used in software engineering.
19+
* **CLI**: [Command Line Interface][] - A way to interact with a computer program using text commands.
20+
* **Code cache**: Chunk of bytes storing compiled JS code and its metadata.
21+
* **CVE**: [Common Vulnerabilities and Exposures][] - Database maintaining reported security vulnerabilities.
22+
* **Deps**: Dependencies - Upstream projects that this project depends on.
23+
* **DOM**: [Document Object Model][] - A programming interface for web documents. It represents the structure of a
24+
document as a tree of objects, allowing programmers to manipulate the content and structure of a web page dynamically.
25+
* **ECMA**: [European Computer Manufacturers Association][] - Governing body over JavaScript's specification.
26+
* **ECMA-262**: [**ECMA**'s standard for JavaScript][].
27+
* **ECMAScript**: JavaScript, as described in **ECMA-262**.
28+
* **EOF**: [End-of-File][] - Indicates the end of a file or stream.
29+
* **EOL**: [End-of-Life][] (when used within project documents), [End-of-Line][] (when used within a program),
30+
End-of-Life is usually how this term is used.
31+
* **ESM**: [ECMAScript Module][] - Standard for JavaScript modules.
32+
* **ETW**: [Event Tracing for Windows][] - Provides a way to trace events in Windows systems.
33+
* **FFDC**: First Failure Data Capture - Logs, traces, and dumps produced by default on program error.
34+
* **FIPS**: [Federal Information Processing Standards][] - Set of standards for use in computer systems by non-military
35+
government agencies and government contractors.
36+
* **FS**: File System.
37+
* **Godbolt**: [Compiler Explorer][] - Tool for running compilers interactively from a web browser.
38+
* **HTTP**: [Hypertext Transfer Protocol][] - An application protocol for distributed, collaborative, hypermedia
39+
information systems. It is the foundation of data communication on the World Wide Web.
40+
* **ICU**: [International Components for Unicode][] - Library providing support for Unicode.
41+
* **IDE**: [Integrated Development Environment][] - A software application that provides comprehensive facilities to
42+
computer programmers for software development.
43+
* **IETF**: [Internet Engineering Task Force][] - An international community responsible for developing and promoting
44+
Internet standards.
45+
* **IIRC**: If I Recall Correctly.
46+
* **IIUC**: If I Understand Correctly.
47+
* **IMHO**: In My Humble/Honest Opinion.
48+
* **IMO**: In My Opinion.
49+
* **IPC**: [Inter-Process Communication][] - Mechanism allowing processes to communicate with each other.
50+
* **JIT**: [Just In Time][] - Method of executing computer code during runtime.
51+
* **JS**: [JavaScript][] - A high-level, interpreted programming language that is primarily used to create dynamic and
52+
interactive content on web pages. It is commonly used for client-side scripting in web development.
53+
* **JS/C++ boundary**: Boundary between V8's runtime and JS code execution, often crossed when calling JS functions
54+
with C++ linkage.
55+
* **JSON**: [JavaScript Object Notation][] - A lightweight data interchange format that is easy for humans to read and
56+
write, and easy for machines to parse and generate. It is commonly used for transmitting data between a server and a
57+
web application.
58+
* **LE**: Little [Endian][] - A Byte Order where the smallest bit comes first. The opposite of **BE**.
59+
* **LGTM/SGTM**: Looks/Sounds good to me - Commonly used to approve a code review.
60+
* **LTS**: [Long Term Support][] - Support provided for a software version for an extended period.
61+
* **MDN**: [Mozilla Development Network][] - Resource for web developers.
62+
* **MVC**: [Model-View-Controller][] - A software design pattern commonly used for developing user interfaces. It
63+
separates the application into three interconnected components: the model (data), the view (presentation), and the
64+
controller (logic).
65+
* **Native modules/addons**: Modules implemented in C/C++ that expose interfaces callable from JS.
66+
67+
<!-- lint disable prohibited-strings -->
68+
69+
* **NPM**: [Node Package Manager][] - A package manager for JavaScript, widely used for managing dependencies in
70+
Node.js projects and for sharing code with others.
71+
72+
<!-- lint enable -->
73+
74+
* **OOB**: Out Of Bounds - Used in the context of array access.
75+
* **OOM**: Out Of Memory - Situation where a computer program exceeds its memory allocation.
76+
* **OOP**: [Object-Oriented Programming][] - A programming paradigm based on the concept of "objects," which can
77+
contain data and code to manipulate that data. OOP languages include features such as encapsulation, inheritance,
78+
and polymorphism.
79+
* **PPC**: [PowerPC][] - A type of microprocessor architecture.
80+
* **Primordials**: Pristine built-ins in JavaScript that are not affected by prototype pollution.
81+
* **Prototype Pollution**: Process in which object prototypes are mutated via user action.
82+
* **RAII**: [Resource Acquisition Is Initialization][] - Programming idiom used to manage resources in C++.
83+
* **REPL**: [Read Evaluate Print Loop][] - Environment for interactive programming.
84+
* **RFC**: [Request For Comments][] - A Document used in standardization processes.
85+
* **RSLGTM/RSSGTM**: Rubber-Stamp Looks/Sounds Good To Me - The reviewer approves without doing a full code review.
86+
* **RSS**: [Resident Set Size][] - Amount of memory occupied by a process in RAM.
87+
* **SMP**: [Symmetric Multi-Processor][] - Architecture where multiple processors share the same memory.
88+
* **Snapshot**: Chunk of bytes containing data serialized from a V8 heap.
89+
* **TBH**: To Be Honest.
90+
* **TSC**: Technical Steering Committee - Governing body within a project.
91+
* **UI**: [User Interface][] - The point of interaction between a user and a computer program. It includes elements
92+
such as buttons, menus, and other graphical elements that allow users to interact with the software.
93+
* **URL**: [Uniform Resource Locator][] - A reference to a web resource that specifies its location on a computer
94+
network and the mechanism for retrieving it, typically using the HTTP or HTTPS protocol.
95+
* **UTF-8**: [Unicode Transformation Format - 8-bit][] - A variable-width character encoding widely used for
96+
representing Unicode characters efficiently in byte-oriented systems.
97+
* **V8**: [The JavaScript engine][] that powers Node.js and Chrome browser.
98+
* **Vendoring**: Consuming external software into this project.
99+
* **VM**: [The Node.js VM module][] - Provides a way of executing JavaScript on a virtual machine.
100+
* **W3C**: [World Wide Web Consortium][] - An international community that develops standards and guidelines for
101+
various aspects of the web.
102+
* **WASI**: [Web Assembly System Interface][] - Interface for WebAssembly.
103+
* **WASM**: Web Assembly - Binary instruction format for a stack-based virtual machine.
104+
* **WG**: Working Group - Autonomous teams in the project with specific focus areas.
105+
* **WHATWG**: [Web Hypertext Application Technology Working Group][] - Community developing web standards.
106+
* **WIP**: Work In Progress - Unfinished work that may be worth an early look.
107+
* **WPT**: [web-platform-tests][] - Test suite for web platform APIs.
108+
109+
[**ECMA**'s standard for JavaScript]: https://ecma-international.org/publications-and-standards/standards/ecma-262/
110+
[Application Binary Interface]: https://en.wikipedia.org/wiki/Application_binary_interface
111+
[Application Programming Interface]: https://en.wikipedia.org/wiki/Application_programming_interface
112+
[Command Line Interface]: https://en.wikipedia.org/wiki/Command-line_interface
113+
[Common Locale Data Repository]: https://en.wikipedia.org/wiki/Common_Locale_Data_Repository
114+
[Common Vulnerabilities and Exposures]: https://cve.org
115+
[CommonJS]: https://en.wikipedia.org/wiki/CommonJS
116+
[CommonJS Modules]: https://nodejs.org/api/modules.html#modules-commonjs-modules
117+
[Compiler Explorer]: https://godbolt.org/
118+
[Continuous Integration]: https://en.wikipedia.org/wiki/Continuous_integration
119+
[Document Object Model]: https://en.wikipedia.org/wiki/Document_Object_Model
120+
[ECMAScript Module]: https://nodejs.org/api/esm.html#modules-ecmascript-modules
121+
[End-of-File]: https://en.wikipedia.org/wiki/End-of-file
122+
[End-of-Life]: https://en.wikipedia.org/wiki/End-of-life_product
123+
[End-of-Line]: https://en.wikipedia.org/wiki/Newline
124+
[Endian]: https://en.wikipedia.org/wiki/Endianness
125+
[European Computer Manufacturers Association]: https://ecma.org
126+
[Event Tracing for Windows]: https://en.wikipedia.org/wiki/Event_Viewer
127+
[Federal Information Processing Standards]: https://en.wikipedia.org/wiki/Federal_Information_Processing_Standards
128+
[Hypertext Transfer Protocol]: https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol
129+
[Integrated Development Environment]: https://en.wikipedia.org/wiki/Integrated_development_environment
130+
[Inter-Process Communication]: https://en.wikipedia.org/wiki/Inter-process_communication
131+
[International Components for Unicode]: https://icu.unicode.org/
132+
[Internet Engineering Task Force]: https://www.ietf.org/
133+
[JavaScript]: https://developer.mozilla.org/en-US/docs/Web/JavaScript
134+
[JavaScript Object Notation]: https://www.json.org/
135+
[Just In Time]: https://en.wikipedia.org/wiki/Just-in-time_compilation
136+
[Long Term Support]: https://en.wikipedia.org/wiki/Long-term_support
137+
[Model-View-Controller]: https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller
138+
[Mozilla Development Network]: https://developer.mozilla.org/en-US
139+
[Node Package Manager]: https://www.npmjs.com/
140+
[Object-Oriented Programming]: https://en.wikipedia.org/wiki/Object-oriented_programming
141+
[PowerPC]: https://en.wikipedia.org/wiki/PowerPC
142+
[Read Evaluate Print Loop]: https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop
143+
[Request For Comments]: https://en.wikipedia.org/wiki/Request_for_Comments
144+
[Resident Set Size]: https://en.wikipedia.org/wiki/Resident_set_size
145+
[Resource Acquisition Is Initialization]: https://en.wikipedia.org/wiki/Resource_acquisition_is_initialization
146+
[Symmetric Multi-Processor]: https://en.wikipedia.org/wiki/Symmetric_multiprocessing
147+
[The JavaScript Engine]: https://en.wikipedia.org/wiki/V8_\(JavaScript_engine\)
148+
[The Node.js VM Module]: https://nodejs.org/api/vm.html
149+
[Unicode Transformation Format - 8-bit]: https://en.wikipedia.org/wiki/UTF-8
150+
[Uniform Resource Locator]: https://en.wikipedia.org/wiki/URL
151+
[User Interface]: https://en.wikipedia.org/wiki/User_interface
152+
[Web Assembly System Interface]: https://github.com/WebAssembly/WASI
153+
[Web Hypertext Application Technology Working Group]: https://en.wikipedia.org/wiki/WHATWG
154+
[World Wide Web Consortium]: https://www.w3.org/
155+
[web-platform-tests]: https://github.com/web-platform-tests/wpt

glossary.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

0 commit comments

Comments
 (0)