WORKING_GROUPS.md

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