@@ -12,49 +12,99 @@ The WG has final authority over this project including:
12
12
* Conduct guidelines
13
13
* Maintaining the list of additional Collaborators
14
14
15
- For the current list of WG members, see the project README.md.
15
+ For the current list of WG members, see [ the project README.md] [ nodejs-docs- ] .
16
16
17
- ## Collaborators
17
+ ## Membership
18
18
19
- The Node.js Documenation WG GitHub repository is maintained by the WG and
20
- additional Collaborators who are added by the WG on an ongoing basis.
19
+ ### Joining the WG
21
20
22
- Individuals making significant and valuable contributions are made Collaborators
23
- and given commit-access to the project. These individuals are identified by the
24
- WG and their addition as Collaborators is discussed over GitHub issues - at time
25
- of writing, these individuals are encouraged to comment on [ this specific
26
- issue] [ ] .
21
+ Membership may be extended by current WG members to individuals who have made
22
+ contributions to documentation in the Node or JavaScript communities who ** have
23
+ expressed interest in membership** . Candidates for membership will be approved
24
+ or denied by existing WG members using the [ Consensus Seeking
25
+ Process] [ consensus ] process below. Individuals may express interest publicly on
26
+ the [ sign-up issue] [ sign-up ] or privately to any existing Docs WG member. Put
27
+ simply: ** if you are a documentarian and are willing to fulfill the
28
+ [ responsibilities of membership] [ membership-responsibilities ] to the best of
29
+ your ability, the Docs WG would be happy to receive your help.**
30
+
31
+ The Docs WG encourages prospective members to read the
32
+ [ CONTRIBUTING.md] [ nodejs-doc-contributing ] and
33
+ [ GETTING-STARTED.md] [ nodejs-doc-getting-started ] documents for an idea of how
34
+ the WG operates.
35
+
36
+ ### Membership Access and Responsibilities
37
+
38
+ Membership in the Node.js Documentation WG entails the following access:
39
+
40
+ * Membership in the [ Node.js Documentation Slack] [ nodejs-doc-slack ] .
41
+ * Membership in the ** @nodejs/documentation ** GitHub team.
42
+ * Collaboratorship on the [ Node.js Documentation Repository] [ nodejs-doc-repo ] .
43
+
44
+ Members should prepare to take part in the following activities, to the best of
45
+ their abilities:
46
+
47
+ * Attend meetings in the form of Google Hangouts.
48
+ * Coordinate via [ ** nodejs/docs** issues] [ nodejs-doc-repo ] .
49
+ * Coordinate with WG members via [ Slack] [ nodejs-doc-slack ] .
50
+ * Respond to pull requests, and issues on the ** nodejs/node** tracker that:
51
+ * are tagged with the ` doc ` label, OR
52
+ * have cc'd ** @nodejs/documentation ** , OR
53
+ * modify the ` doc/ ` or ` tools/docs ` directory.
54
+ * Apply the [ editing standards] [ nodejs-doc-standards ] recommended by the WG to
55
+ all documentation review.
56
+ * Keep the [ goals] [ nodejs-doc-goals ] set by the WG in mind when contributing
57
+ documentation.
58
+
59
+ ** The WG recognizes that this is largely a volunteer effort, and will endeavour
60
+ to adjust the time commitment of participation in the WG to reflect that.** If
61
+ you would like to contribute, but cannot participate in one or more of the
62
+ above tasks, please contact a WG member. The WG will attempt to make
63
+ accomodations for interested individuals. * Members are not required to be
64
+ collaborators on the ` nodejs/node ` repository.*
65
+
66
+ Members are expected to conduct themselves according to the [ Docs WG Code of
67
+ Conduct] [ nodejs-doc-coc ] as well as any Code of Conduct set by the larger Node
68
+ Foundation. The Code of Conduct is enforced by the [ Moderation
69
+ WG] [ nodejs-moderation ] . Any Docs WG banned from the Node project by the
70
+ Moderation WG will also be removed from the Docs WG. To report a violation of
71
+ the Code of Conduct, please [ follow the steps listed
72
+ here] [ nodejs-moderation-request ] .
73
+
74
+ ### Membership Collaboration
75
+
76
+ #### Documentation Review and Copyediting
77
+
78
+ Follow the process outlined in [ CONTRIBUTING.md] [ nodejs-doc-contributing ] .
79
+
80
+ #### Changes to Docs WG Guidelines and Process
27
81
28
82
Modifications of the contents of the Node.js Documentation WG repository are
29
83
made on a collaborative basis. Anybody with a GitHub account may propose a
30
84
modification via pull request and it will be considered by the project
31
- Collaborators. All pull requests must be reviewed and accepted by a Collaborator
32
- with sufficient expertise who is able to take full responsibility for the
33
- change. In the case of pull requests proposed by an existing Collaborator, an
34
- additional Collaborator is required participate if there is disagreement around
35
- a particular modification. See _ Consensus Seeking Process_ below for further
36
- detail on the consensus model used for governance.
85
+ Collaborators. All pull requests must be reviewed and accepted by a
86
+ Collaborator with sufficient expertise who is able to take full responsibility
87
+ for the change. In the case of pull requests proposed by an existing
88
+ Collaborator, an additional Collaborator is required participate if there is
89
+ disagreement around a particular modification. [ See _ Consensus Seeking Process_
90
+ below] [ consensus ] for further detail on the consensus model used for
91
+ governance.
37
92
38
93
Collaborators may opt to elevate significant or controversial modifications, or
39
94
modifications that have not found consensus, to the WG for discussion by
40
95
assigning the ` wg-agenda ` tag to a pull request or issue. The WG should serve as
41
96
the final arbiter where required.
42
97
43
- For the current list of Collaborators, see the project ` README.md ` .
44
-
45
- ## WG Membership
98
+ #### Additional Membership Constraints
46
99
47
- WG seats are not time-limited. There is no fixed size of the WG. However, the
48
- expected target is between 6 and 12, to ensure adequate coverage of important
49
- areas of expertise, balanced with the ability to make decisions efficiently.
50
-
51
- There is no specific set of requirements or qualifications for WG membership
52
- beyond these rules.
100
+ WG seats are not time-limited. There is no fixed size of the WG. There is no
101
+ specific set of requirements or qualifications for WG membership beyond rules
102
+ set forth in this document.
53
103
54
104
The WG may add additional members to the WG by unanimous consensus.
55
105
56
- A WG member may be removed from the WG by voluntary resignation, or by unanimous
57
- consensus of all other WG members.
106
+ A WG member may be removed from the WG by voluntary resignation, by unanimous
107
+ consensus of all other WG members, or by ruling from the Node.js Moderation WG .
58
108
59
109
Changes to WG membership should be posted in the agenda, and may be suggested as
60
110
any other agenda item (see "WG Meetings" below).
@@ -65,15 +115,7 @@ creates a situation where more than 1/3 of the WG membership shares an employer,
65
115
then the situation must be immediately remedied by the resignation or removal of
66
116
one or more WG members affiliated with the over-represented employer(s).
67
117
68
- ## WG Agenda
69
-
70
- <!-- this part needs to be rewritten. Will follow up with another commit that has those edits. -->
71
-
72
- Each week, an issue tagged ` wg-weekly ` will be created. It will be a sort of
73
- weekly digest on what's happened within the docs WG. The ` wg-weekly ` posts will
74
- contain links and descriptions to issues tagged with ` wg-agenda ` . The topics
75
- links are to be discussed within their respective ` wg-agenda ` tagged issues, ** not**
76
- in the ` wg-weekly ` topics.
118
+ #### WG Meeting Agenda
77
119
78
120
Items are tagged with ` wg-agenda ` which are considered contentious or are
79
121
modifications of governance, contribution policy, WG membership, or release
@@ -91,9 +133,11 @@ tag to the issue themselves.
91
133
The moderator is responsible for summarizing the discussion of each agenda item
92
134
and send it as a pull request after the meeting.
93
135
94
- ### Consensus Seeking Process
136
+ A regular cadence will be determined for meetings by consent of the WG.
137
+
138
+ #### Consensus Seeking Process
95
139
96
- The WG follows a [ Consensus Seeking] [ ] decision making model.
140
+ The WG follows a [ Consensus Seeking] [ external-consensus ] decision making model.
97
141
98
142
When an agenda item has appeared to reach a consensus the moderator will ask
99
143
"Does anyone object?" as a final call for dissent from the consensus.
@@ -106,5 +150,16 @@ continue. Simple majority wins.
106
150
Note that changes to WG membership require unanimous consensus. See "WG
107
151
Membership" above.
108
152
109
- [ this specific issue ] : https://github.com/nodejs/docs/issues/2
110
- [ Consensus Seeking ] : http://en.wikipedia.org/wiki/Consensus-seeking_decision-making
153
+ [ consensus ] : #consensus-seeking-process
154
+ [ sign-up ] : https://github.com/nodejs/docs/issues/2
155
+ [ membership-responsibilities ] : #membership-access-and-responsibilities
156
+ [ nodejs-doc-slack ] : https://nodejs-docs.slack.com/
157
+ [ nodejs-doc-repo ] : https://github.com/nodejs/docs
158
+ [ nodejs-doc-standards ] : https://github.com/nodejs/docs/blob/master/GETTING-STARTED.md#how-we-write
159
+ [ nodejs-doc-goals ] : https://github.com/nodejs/docs/blob/master/GETTING-STARTED.md#why-we-write-docs
160
+ [ nodejs-doc-coc ] : https://github.com/nodejs/docs/blob/master/CONTRIBUTING.md#code-of-conduct
161
+ [ nodejs-moderation ] : https://github.com/nodejs/moderation
162
+ [ nodejs-moderation-request ] : https://github.com/nodejs/TSC/blob/master/Moderation-Policy.md#requesting-moderation
163
+ [ nodejs-doc-contributing ] : ./CONTRIBUTING.md
164
+ [ nodejs-doc-getting-started ] : ./GETTING-STARTED.md
165
+ [ external-consensus ] : http://en.wikipedia.org/wiki/Consensus-seeking_decision-making
0 commit comments