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