Skip to content

Commit 9148e96

Browse files
bmuenzenmeyermhdawson
authored andcommitted
doc: add ambassaor message
PR-URL: #57600 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Marco Ippolito <[email protected]>
1 parent 74c8358 commit 9148e96

File tree

1 file changed

+62
-19
lines changed

1 file changed

+62
-19
lines changed

doc/contributing/advocacy-ambassador-program.md

+62-19
Original file line numberDiff line numberDiff line change
@@ -123,29 +123,29 @@ when no longer relevant.
123123

124124
The goal is to raise awareness of XYZ in the JavaScript ecosystem.
125125

126-
#### Related Links
126+
##### Related Links
127127

128-
List of links with more information about the topic to provide brackground
128+
List of links with more information about the topic to provide background
129129
or the information to be shared.
130130

131-
#### Project contacts
131+
##### Project contacts
132132

133133
Add a list of GitHub handles for those within the project that
134-
have volunteered to be contacated when necessary by ambassadors
134+
have volunteered to be contacted when necessary by ambassadors
135135
to get more info about the message to be promoted.
136136

137137
#### Node.js is a great choice for a JavaScript runtime
138138

139139
##### Goal
140140

141-
Highlight the benefits of chosing Node.js as your backend JavaScript runtime. Focus on what is great
141+
Highlight the benefits of choosing Node.js as your backend JavaScript runtime. Focus on what is great
142142
about Node.js without drawing comparisons to alternatives. We don't want to say negative things about
143143
other options, only highlight what is great about Node.js as a choice.
144144

145145
Some of the things to highlight include:
146146

147-
* How widely it is used (you never get fired for chosing Node.js).
148-
* The openess of the project. It is part of the OpenJS Foundation and it's governance is set up to avoid
147+
* How widely it is used (you never get fired for choosing Node.js).
148+
* The openness of the project. It is part of the OpenJS Foundation and it's governance is set up to avoid
149149
any one company from dominating the project. Decisions are made by the collaborators (of which there are quite
150150
a few) versus a small number of people.
151151
* It has predictable and stable releases and has delivered on the release schedule since 2015.
@@ -157,21 +157,21 @@ Some of the things to highlight include:
157157
* Single threaded programming model enables very low resource consumption, making it ideal for containerised workloads.
158158
* Highly vibrant ecosystem with enterprise support from many vendors.
159159

160-
#### Related Links
160+
##### Related Links
161161

162162
* <https://github.com/nodejs/release>
163163
* <https://github.com/nodejs/node/blob/main/doc/contributing/security-release-process.md>
164164
* <https://github.com/nodejs/TSC/blob/main/TSC-Charter.md>
165165
* <https://github.com/mhdawson/presentations/blob/main/2024/NodeConfEU_2024-Node.js_whats_next.pdf>
166166
for slide usage and topping recent surveys.
167167

168-
#### Project contacts
168+
##### Project contacts
169169

170170
* @mhdawson
171171

172-
### How things get done in the Node.js project
172+
#### How things get done in the Node.js project
173173

174-
#### Goal
174+
##### Goal
175175

176176
Help people understand that no people are paid to answer their issues or
177177
implement their pull requests. Things get done based on what volunteers work on
@@ -182,7 +182,7 @@ Some of the things to highlight include:
182182
* Nobody is paid specifically to answer issues, fix bugs or implement new features.
183183
* No company owns/supports Node.js. Most contributions are from individuals
184184
as opposed to organizations. When an individual becomes a collaborator
185-
the access and priviledges are granted to the indidual, their employer does
185+
the access and privileges are granted to the individual, their employer does
186186
not gain any additional rights in the project.
187187
* The governance of the project is specifically designed to prevent one or
188188
a small number of companies from dominating the project.
@@ -198,10 +198,10 @@ Some of the things to highlight include:
198198
* People are volunteering their time to review your PRs and answer questions in
199199
the issues you open. Be mindfull of your asks for their time and acknowledge
200200
the gift of their time. Too many issues/PRs in a short period of time may
201-
overwelm maintainers leading to less progress versus more, try to pace your
201+
overwhelm maintainers leading to less progress versus more, try to pace your
202202
issues and PRs so that you don't have too many open at the same time. The
203-
same goes for comments in discussions, try to avoid overwelming a discussion
204-
with too many responses, even too much useful data can overwelm a discussion
203+
same goes for comments in discussions, try to avoid overwhelming a discussion
204+
with too many responses, even too much useful data can overwhelm a discussion
205205
leading to lower engagement.
206206
* While volunteers work to do the right thing for the community, the project
207207
does not owe anybody anything and does not tolerate abusive or
@@ -210,11 +210,11 @@ Some of the things to highlight include:
210210
* If you depend on timely support or an SLA, contract with a company that provides
211211
paid support and will prioritize your issues.
212212

213-
#### Related Links
213+
##### Related Links
214214

215215
* <https://github.com/nodejs/TSC/blob/main/TSC-Charter.md#section-3-establishment-of-the-tsc>
216216

217-
#### Project contacts
217+
##### Project contacts
218218

219219
* @mcollina
220220
* @mhdawson
@@ -233,7 +233,7 @@ Some of the things to highlight include:
233233
* The `tsconfig.json` configuration options to use in combination for type checking.
234234
* Updates on the implementation advancements.
235235

236-
#### Related Links
236+
##### Related Links
237237

238238
<!-- lint disable prohibited-strings remark-lint-->
239239

@@ -245,6 +245,49 @@ Some of the things to highlight include:
245245

246246
<!-- lint enable prohibited-strings remark-lint-->
247247

248-
#### Project contacts
248+
##### Project contacts
249249

250250
* @marco-ippolito
251+
252+
#### Do I still need this dependency for my Node.js app?
253+
254+
##### Goal
255+
256+
Advancements over time in Node.js are improving the out of the box experience.
257+
New versions are released all the time across Active LTS and Current development lines.
258+
It's easy to miss something between the release notes and our busy work schedules.
259+
260+
Each of these on its own is respectable, but together they make a more cohesive narrative.
261+
This also shows a [healthy ecosystem at work](https://brianmuenzenmeyer.com/posts/2024-do-i-need-this-node-dependency/#oss-pace-layers),
262+
with projects learning from one another and their users.
263+
264+
"Recent" new or newish features, ordered by availability:
265+
266+
| Feature | Introduced | Release Status |
267+
| ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ------------------------------------------------------------------ |
268+
| [testing source code](https://nodejs.org/api/test.html) | [16.17.0](https://nodejs.org/en/blog/release/v16.17.0) | Stable as of 20.0.0 |
269+
| [watching source code](https://nodejs.org/api/cli.html#--watch) | [16.19.0](https://nodejs.org/en/blog/release/v16.19.0) | Stable as of 20.13.0 |
270+
| [parsing arguments](https://nodejs.org/api/util.html#utilparseargsconfig) | [18.3.0](https://nodejs.org/en/blog/release/v18.3.0) | Stable as of 20.0.0 |
271+
| [reading environment](https://nodejs.org/api/cli.html#--env-fileconfig) | [20.6.0](https://nodejs.org/en/blog/release/v20.6.0) | Active Development |
272+
| [styling output](https://nodejs.org/docs/latest-v22.x/api/util.html#utilstyletextformat-text-options) | [20.12.0](https://nodejs.org/en/blog/release/v20.12.0) | Stable, as of [22.13.0](https://github.com/nodejs/node/pull/56329) |
273+
| [run scripts](https://nodejs.org/docs/latest/api/cli.html#--run) | [22.0.0](https://nodejs.org/en/blog/release/v22.0.0) | Stable, as of 22.0.0 |
274+
| [run TypeScript](https://nodejs.org/api/cli.html#--experimental-strip-types) | [22.6.0](https://nodejs.org/en/blog/release/v22.6.0) | Active Development |
275+
276+
##### Related Links
277+
278+
<!-- lint disable prohibited-strings remark-lint-->
279+
280+
* <https://brianmuenzenmeyer.com/posts/2024-do-i-need-this-node-dependency/>
281+
* <https://nodejs.org/api/test.html>
282+
* <https://nodejs.org/api/cli.html#--watch>
283+
* <https://nodejs.org/api/util.html#utilparseargsconfig>
284+
* <https://nodejs.org/api/cli.html#--env-fileconfig>
285+
* <https://nodejs.org/docs/latest-v22.x/api/util.html#utilstyletextformat-text-options>
286+
* <https://nodejs.org/api/cli.html#--run>
287+
* <https://nodejs.org/api/cli.html#--experimental-strip-types>
288+
289+
<!-- lint enable prohibited-strings remark-lint-->
290+
291+
##### Project contacts
292+
293+
* @bmuenzenmeyer

0 commit comments

Comments
 (0)