doc: improvements to console.markdown copy
[platform/upstream/nodejs.git] / WORKING_GROUPS.md
1 # Node.js Working Groups
2
3 Node.js Working Groups are autonomous projects created by the
4 [Technical Steering Committee (TSC)](https://github.com/nodejs/node/blob/master/GOVERNANCE.md#technical-committee).
5
6 Working Groups can be formed at any time but must be ratified by the TSC.
7 Once formed the work defined in the Working Group charter is the
8 responsibility of the WG rather than the TSC.
9
10 It is important that Working Groups are not formed pre-maturely. Working
11 Groups are not formed to *begin* a set of tasks but instead are formed
12 once that work is already underway and the contributors
13 think it would benefit from being done as an autonomous project.
14
15 If the work defined in a Working Group charter is completed the Working
16 Group should be dissolved and the responsibility for governance absorbed
17 back in to the TSC.
18
19 ## Current Working Groups
20
21 * [Website](#website)
22 * [Streams](#streams)
23 * [Build](#build)
24 * [Tracing](#tracing)
25 * [i18n](#i18n)
26 * [Evangelism](#evangelism)
27 * [Roadmap](#roadmap)
28 * [Docker](#docker)
29 * [Addon API](#addon-api)
30 * [Benchmarking](#benchmarking)
31 * [Post-mortem](#post-mortem)
32 * [Intl](#intl)
33 * [HTTP](#http)
34
35 #### Process:
36
37 * [Starting a Working Group](#starting-a-wg)
38 * [Bootstrap Governance](#bootstrap-governance)
39
40 ### [Website](https://github.com/nodejs/website)
41
42 The website working group's purpose is to build and maintain a public
43 website for the `Node.js` project.
44
45 Its responsibilities are:
46 * Develop and maintain a build and automation system for `nodejs.org`.
47 * Ensure the site is regularly updated with changes made to `Node.js` like
48 releases and features.
49 * Foster and enable a community of translators.
50
51 ### [Streams](https://github.com/nodejs/readable-stream)
52
53 The Streams WG is dedicated to the support and improvement of the Streams API
54 as used in Node.js and the npm ecosystem. We seek to create a composable API that
55 solves the problem of representing multiple occurrences of an event over time
56 in a humane, low-overhead fashion. Improvements to the API will be driven by
57 the needs of the ecosystem; interoperability and backwards compatibility with
58 other solutions and prior versions are paramount in importance. Our
59 responsibilities include:
60
61 * Addressing stream issues on the Node.js issue tracker.
62 * Authoring and editing stream documentation within the Node.js project.
63 * Reviewing changes to stream subclasses within the Node.js project.
64 * Redirecting changes to streams from the Node.js project to this project.
65 * Assisting in the implementation of stream providers within Node.js.
66 * Recommending versions of readable-stream to be included in Node.js.
67 * Messaging about the future of streams to give the community advance notice of changes.
68
69
70 ### [Build](https://github.com/nodejs/build)
71
72 The build working group's purpose is to create and maintain a
73 distributed automation infrastructure.
74
75 Its responsibilities are:
76 * Produce Packages for all target platforms.
77 * Run tests.
78 * Run performance testing and comparisons.
79 * Creates and manages build-containers.
80
81
82 ### [Tracing](https://github.com/nodejs/tracing-wg)
83
84 The tracing working group's purpose is to increase the
85 transparency of software written in Node.js.
86
87 Its responsibilities are:
88 * Collaboration with V8 to integrate with `trace_event`.
89 * Maintenance and iteration on AsyncWrap.
90 * Maintenance and improvements to system tracing support (DTrace, LTTng, etc.)
91 * Documentation of tracing and debugging techniques.
92 * Fostering a tracing and debugging ecosystem.
93
94 ### i18n
95
96 The i18n working groups handle more than just translations. They
97 are endpoints for community members to collaborate with each
98 other in their language of choice.
99
100 Each team is organized around a common spoken language. Each
101 language community might then produce multiple localizations for
102 various project resources.
103
104 Their responsibilities are:
105 * Translations of any Node.js materials they believe are relevant to their
106 community.
107 * Review processes for keeping translations up
108 to date and of high quality.
109 * Social media channels in their language.
110 * Promotion of Node.js speakers for meetups and conferences in their
111 language.
112
113 Note that the i18n working groups are distinct from the [Intl](#Intl) working group.
114
115 Each language community maintains its own membership.
116
117 * [nodejs-ar - Arabic (اللغة العربية)](https://github.com/nodejs/nodejs-ar)
118 * [nodejs-bg - Bulgarian (български език)](https://github.com/nodejs/nodejs-bg)
119 * [nodejs-bn - Bengali (বাংলা)](https://github.com/nodejs/nodejs-bn)
120 * [nodejs-zh-CN - Chinese (中文)](https://github.com/nodejs/nodejs-zh-CN)
121 * [nodejs-cs - Czech (Český Jazyk)](https://github.com/nodejs/nodejs-cs)
122 * [nodejs-da - Danish (Dansk)](https://github.com/nodejs/nodejs-da)
123 * [nodejs-de - German (Deutsch)](https://github.com/nodejs/nodejs-de)
124 * [nodejs-el - Greek (Ελληνικά)](https://github.com/nodejs/nodejs-el)
125 * [nodejs-es - Spanish (Español)](https://github.com/nodejs/nodejs-es)
126 * [nodejs-fa - Persian (فارسی)](https://github.com/nodejs/nodejs-fa)
127 * [nodejs-fi - Finnish (Suomi)](https://github.com/nodejs/nodejs-fi)
128 * [nodejs-fr - French (Français)](https://github.com/nodejs/nodejs-fr)
129 * [nodejs-he - Hebrew (עברית)](https://github.com/nodejs/nodejs-he)
130 * [nodejs-hi - Hindi (फिजी बात)](https://github.com/nodejs/nodejs-hi)
131 * [nodejs-hu - Hungarian (Magyar)](https://github.com/nodejs/nodejs-hu)
132 * [nodejs-id - Indonesian (Bahasa Indonesia)](https://github.com/nodejs/nodejs-id)
133 * [nodejs-it - Italian (Italiano)](https://github.com/nodejs/nodejs-it)
134 * [nodejs-ja - Japanese (日本語)](https://github.com/nodejs/nodejs-ja)
135 * [nodejs-ka - Georgian (ქართული)](https://github.com/nodejs/nodejs-ka)
136 * [nodejs-ko - Korean (조선말)](https://github.com/nodejs/nodejs-ko)
137 * [nodejs-mk - Macedonian (Mакедонски)](https://github.com/nodejs/nodejs-mk)
138 * [nodejs-ms - Malay (بهاس ملايو)](https://github.com/nodejs/nodejs-ms)
139 * [nodejs-nl - Dutch (Nederlands)](https://github.com/nodejs/nodejs-nl)
140 * [nodejs-no - Norwegian (Norsk)](https://github.com/nodejs/nodejs-no)
141 * [nodejs-pl - Polish (Język Polski)](https://github.com/nodejs/nodejs-pl)
142 * [nodejs-pt - Portuguese (Português)](https://github.com/nodejs/nodejs-pt)
143 * [nodejs-ro - Romanian (Română)](https://github.com/nodejs/nodejs-ro)
144 * [nodejs-ru - Russian (Русский)](https://github.com/nodejs/nodejs-ru)
145 * [nodejs-sv - Swedish (Svenska)](https://github.com/nodejs/nodejs-sv)
146 * [nodejs-ta - Tamil (தமிழ்)](https://github.com/nodejs/nodejs-ta)
147 * [nodejs-tr - Turkish (Türkçe)](https://github.com/nodejs/nodejs-tr)
148 * [nodejs-zh-TW - Taiwanese (Hō-ló)](https://github.com/nodejs/nodejs-zh-TW)
149 * [nodejs-uk - Ukrainian (Українська)](https://github.com/nodejs/nodejs-uk)
150 * [nodejs-vi - Vietnamese (Tiếng Việtnam)](https://github.com/nodejs/nodejs-vi)
151
152 ### [Intl](https://github.com/nodejs/Intl)
153
154 The Intl Working Group is dedicated to support and improvement of
155 Internationalization (i18n) and Localization (l10n) in Node. Its responsibilities are:
156
157 1. Functionality & compliance (standards: ECMA, Unicode…)
158 2. Support for Globalization and Internationalization issues that come up in the tracker
159 3. Guidance and Best Practices
160 4. Refinement of existing `Intl` implementation
161
162 The Intl WG is not responsible for translation of content. That is the responsibility of the specific [i18n](#i18n) group for each language.
163
164 ### [Evangelism](https://github.com/nodejs/evangelism)
165
166 The evangelism working group promotes the accomplishments
167 of Node.js and lets the community know how they can get involved.
168
169 Their responsibilities are:
170 * Project messaging.
171 * Official project social media.
172 * Promotion of speakers for meetups and conferences.
173 * Promotion of community events.
174 * Publishing regular update summaries and other promotional
175 content.
176
177 ### [HTTP](https://github.com/nodejs/http)
178
179 The HTTP working group is chartered for the support and improvement of the
180 HTTP implementation in Node. It's responsibilities are:
181
182 * Addressing HTTP issues on the Node.js issue tracker.
183 * Authoring and editing HTTP documentation within the Node.js project.
184 * Reviewing changes to HTTP functionality within the Node.js project.
185 * Working with the ecosystem of HTTP related module developers to evolve the
186   HTTP implementation and APIs in core.
187 * Advising the CTC on all HTTP related issues and discussions.
188 * Messaging about the future of HTTP to give the community advance notice of
189   changes.
190
191 ### [Roadmap](https://github.com/nodejs/roadmap)
192
193 The roadmap working group is responsible for user community outreach
194 and the translation of their concerns into a plan of action for Node.js.
195
196 The final [ROADMAP](./ROADMAP.md) document is still owned by the TC and requires
197 the same approval for changes as any other project asset.
198
199 Their responsibilities are:
200 * Attract and summarize user community needs and feedback.
201 * Find or potentially create tools that allow for broader participation.
202 * Create Pull Requests for relevant changes to [Roadmap.md](./ROADMAP.md)
203
204
205 ### [Docker](https://github.com/nodejs/docker-iojs)
206
207 The Docker working group's purpose is to build, maintain, and improve official
208 Docker images for the `Node.js` project.
209
210 Their responsibilities are:
211 * Keep the official Docker images updated in line with new `Node.js` releases.
212 * Decide and implement image improvements and/or fixes.
213 * Maintain and improve the images' documentation.
214
215
216 ### [Addon API](https://github.com/nodejs/nan)
217
218 The Addon API Working Group is responsible for maintaining the NAN project and
219 corresponding _nan_ package in npm. The NAN project makes available an
220 abstraction layer for native add-on authors for both Node.js and Node.js,
221 assisting in the writing of code that is compatible with many actively used
222 versions of Node.js, Node.js, V8 and libuv.
223
224 Their responsibilities are:
225
226 * Maintaining the [NAN](https://github.com/nodejs/nan) GitHub repository,
227   including code, issues and documentation.
228 * Maintaining the [addon-examples](https://github.com/nodejs/node-addon-examples)
229   GitHub repository, including code, issues and documentation.
230 * Maintaining the C++ Addon API within the Node.js project, in subordination to
231   the Node.js TSC.
232 * Maintaining the Addon documentation within the Node.js project, in
233   subordination to the Node.js TSC.
234 * Maintaining the _nan_ package in npm, releasing new versions as appropriate.
235 * Messaging about the future of the Node.js and NAN interface to give the
236   community advance notice of changes.
237
238 The current members can be found in their
239 [README](https://github.com/nodejs/nan#collaborators).
240
241 ### [Benchmarking](https://github.com/nodejs/benchmarking)
242
243 The purpose of the Benchmark working group is to gain consensus
244 for an agreed set of benchmarks that can be used to:
245
246 + track and evangelize performance gains made between Node releases
247 + avoid performance regressions between releases
248
249 Its responsibilities are:
250
251 + Identify 1 or more benchmarks that reflect customer usage.
252    Likely need more than one to cover typical Node use cases
253    including low-latency and high concurrency
254 + Work to get community consensus on the list chosen
255 + Add regular execution of chosen benchmarks to Node builds
256 + Track/publicize performance between builds/releases
257
258 ### [Post-mortem](https://github.com/nodejs/post-mortem)
259
260 The Post-mortem Diagnostics working group is dedicated to the support
261 and improvement of postmortem debugging for Node.js. It seeks to
262 elevate the role of postmortem debugging for Node, to assist in the
263 development of techniques and tools, and to make techniques and tools
264 known and available to Node.js users.
265
266 Its responsibilities are:
267
268 + Defining and adding interfaces/APIs in order to allow dumps
269   to be generated when needed
270 + Defining and adding common structures to the dumps generated
271   in order to support tools that want to introspect those dumps
272
273 ## Starting a WG
274
275 A Working Group is established by first defining a charter  that can be
276 ratified by the TC. A charter is a *statement of purpose*, a
277 *list of responsibilities* and a *list of initial membership*.
278
279 A working group needs 3 initial members. These should be individuals
280 already undertaking the work described in the charter.
281
282 The list of responsibilities should be specific. Once established, these
283 responsibilities are no longer governed by the TC and therefore should
284 not be broad or subjective. The only recourse the TC has over the working
285 group is to revoke the entire charter and take on the work previously
286 done by the working group themselves.
287
288 If the responsibilities described in the charter are currently
289 undertaken by another WG then the charter will additionally have to be
290 ratified by that WG.
291
292 You can submit the WG charter for ratification by sending
293 a Pull Request to this document, which adds it to the
294 list of current Working Groups. Once ratified the list of
295 members should be maintained in the Working Group's
296 README.
297
298 ## Bootstrap Governance
299
300 Once the TC ratifies a charter the WG inherits the following
301 documentation for governance, contribution, conduct and an MIT
302 LICENSE. The WG is free to change these documents through their own
303 governance process, hence the term "bootstrap."
304
305 ### *[insert WG name]* Working Group
306
307 The Node.js *[insert WG name]* is jointly governed by a Working Group (WG)
308 that is responsible for high-level guidance of the project.
309
310 The WG has final authority over this project including:
311
312 * Technical direction
313 * Project governance and process (including this policy)
314 * Contribution policy
315 * GitHub repository hosting
316 * Conduct guidelines
317 * Maintaining the list of additional Collaborators
318
319 For the current list of WG members, see the project
320 [README.md](./README.md#current-project-team-members).
321
322 ### Collaborators
323
324 The *[insert WG name]* GitHub repository is
325 maintained by the WG and additional Collaborators who are added by the
326 WG on an ongoing basis.
327
328 Individuals making significant and valuable contributions are made
329 Collaborators and given commit-access to the project. These
330 individuals are identified by the WG and their addition as
331 Collaborators is discussed during the weekly WG meeting.
332
333 _Note:_ If you make a significant contribution and are not considered
334 for commit-access log an issue or contact a WG member directly and it
335 will be brought up in the next WG meeting.
336
337 Modifications of the contents of the *[insert WG repo]* repository are made on
338 a collaborative basis. Anybody with a GitHub account may propose a
339 modification via pull request and it will be considered by the project
340 Collaborators. All pull requests must be reviewed and accepted by a
341 Collaborator with sufficient expertise who is able to take full
342 responsibility for the change. In the case of pull requests proposed
343 by an existing Collaborator, an additional Collaborator is required
344 for sign-off. Consensus should be sought if additional Collaborators
345 participate and there is disagreement around a particular
346 modification. See _Consensus Seeking Process_ below for further detail
347 on the consensus model used for governance.
348
349 Collaborators may opt to elevate significant or controversial
350 modifications, or modifications that have not found consensus to the
351 WG for discussion by assigning the ***WG-agenda*** tag to a pull
352 request or issue. The WG should serve as the final arbiter where
353 required.
354
355 For the current list of Collaborators, see the project
356 [README.md](./README.md#current-project-team-members).
357
358 ### WG Membership
359
360 WG seats are not time-limited.  There is no fixed size of the WG.
361 However, the expected target is between 6 and 12, to ensure adequate
362 coverage of important areas of expertise, balanced with the ability to
363 make decisions efficiently.
364
365 There is no specific set of requirements or qualifications for WG
366 membership beyond these rules.
367
368 The WG may add additional members to the WG by unanimous consensus.
369
370 A WG member may be removed from the WG by voluntary resignation, or by
371 unanimous consensus of all other WG members.
372
373 Changes to WG membership should be posted in the agenda, and may be
374 suggested as any other agenda item (see "WG Meetings" below).
375
376 If an addition or removal is proposed during a meeting, and the full
377 WG is not in attendance to participate, then the addition or removal
378 is added to the agenda for the subsequent meeting.  This is to ensure
379 that all members are given the opportunity to participate in all
380 membership decisions.  If a WG member is unable to attend a meeting
381 where a planned membership decision is being made, then their consent
382 is assumed.
383
384 No more than 1/3 of the WG members may be affiliated with the same
385 employer.  If removal or resignation of a WG member, or a change of
386 employment by a WG member, creates a situation where more than 1/3 of
387 the WG membership shares an employer, then the situation must be
388 immediately remedied by the resignation or removal of one or more WG
389 members affiliated with the over-represented employer(s).
390
391 ### WG Meetings
392
393 The WG meets weekly on a Google Hangout On Air. A designated moderator
394 approved by the WG runs the meeting. Each meeting should be
395 published to YouTube.
396
397 Items are added to the WG agenda that are considered contentious or
398 are modifications of governance, contribution policy, WG membership,
399 or release process.
400
401 The intention of the agenda is not to approve or review all patches;
402 that should happen continuously on GitHub and be handled by the larger
403 group of Collaborators.
404
405 Any community member or contributor can ask that something be added to
406 the next meeting's agenda by logging a GitHub Issue. Any Collaborator,
407 WG member or the moderator can add the item to the agenda by adding
408 the ***WG-agenda*** tag to the issue.
409
410 Prior to each WG meeting the moderator will share the Agenda with
411 members of the WG. WG members can add any items they like to the
412 agenda at the beginning of each meeting. The moderator and the WG
413 cannot veto or remove items.
414
415 The WG may invite persons or representatives from certain projects to
416 participate in a non-voting capacity.
417
418 The moderator is responsible for summarizing the discussion of each
419 agenda item and sends it as a pull request after the meeting.
420
421 ### Consensus Seeking Process
422
423 The WG follows a
424 [Consensus Seeking](http://en.wikipedia.org/wiki/Consensus-seeking_decision-making)
425 decision-making model.
426
427 When an agenda item has appeared to reach a consensus the moderator
428 will ask "Does anyone object?" as a final call for dissent from the
429 consensus.
430
431 If an agenda item cannot reach a consensus a WG member can call for
432 either a closing vote or a vote to table the issue to the next
433 meeting. The call for a vote must be seconded by a majority of the WG
434 or else the discussion will continue. Simple majority wins.
435
436 Note that changes to WG membership require unanimous consensus.  See
437 "WG Membership" above.
438
439 ### Developer's Certificate of Origin 1.0
440
441 By making a contribution to this project, I certify that:
442
443 * (a) The contribution was created in whole or in part by me and I
444   have the right to submit it under the open source license indicated
445   in the file; or
446 * (b) The contribution is based upon previous work that, to the best
447   of my knowledge, is covered under an appropriate open source license
448   and I have the right under that license to submit that work with
449   modifications, whether created in whole or in part by me, under the
450   same open source license (unless I am permitted to submit under a
451   different license), as indicated in the file; or
452 * (c) The contribution was provided directly to me by some other
453   person who certified (a), (b) or (c) and I have not modified it.
454
455 ### Moderation Policy
456
457 The [Node.js Moderation Policy] applies to this WG.
458
459 ### Code of Conduct
460
461 The [Node.js Code of Conduct][] applies to this WG.
462
463 [Node.js Code of Conduct]: https://github.com/nodejs/node/blob/master/CODE_OF_CONDUCT.md
464 [Node.js Moderation Policy]: https://github.com/nodejs/TSC/blob/master/Moderation-Policy.md