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