]> git.proxmox.com Git - pve-eslint.git/blob - eslint/docs/src/maintainer-guide/governance.md
0705b6469600a1534e7431985e499dc56a361106
[pve-eslint.git] / eslint / docs / src / maintainer-guide / governance.md
1 ---
2 title: Governance
3 layout: doc
4 eleventyNavigation:
5 key: governance
6 parent: maintainer guide
7 title: Governance
8 order: 4
9
10 ---
11
12 ESLint is an open source project that depends on contributions from the community. Anyone may contribute to the project at any time by submitting code, participating in discussions, making suggestions, or any other contribution they see fit. This document describes how various types of contributors work within the ESLint project.
13
14 ## Roles and Responsibilities
15
16 ### Users
17
18 Users are community members who have a need for the project. Anyone can be a User; there are no special requirements. Common User contributions include evangelizing the project (e.g., display a link on a website and raise awareness through word-of-mouth), informing developers of strengths and weaknesses from a new user perspective, or providing moral support (a "thank you" goes a long way).
19
20 Users who continue to engage with the project and its community will often become more and more involved. Such Users may find themselves becoming Contributors, as described in the next section.
21
22 ### Contributors
23
24 Contributors are community members who contribute in concrete ways to the project, most often in the form of code and/or documentation. Anyone can become a Contributor, and contributions can take many forms. There is no expectation of commitment to the project, no specific skill requirements, and no selection process.
25
26 Contributors have read-only access to source code and so submit changes via pull requests. Contributor pull requests have their contribution reviewed and merged by a TSC member. TSC members and Committers work with Contributors to review their code and prepare it for merging.
27
28 As Contributors gain experience and familiarity with the project, their profile within, and commitment to, the community will increase. At some stage, they may find themselves being nominated as either a Website Team Member or Committer by an existing Website Team Member or Committer.
29
30 ### Website Team Member
31
32 Website Team Members are community members who have shown that they are committed to the continued maintenance of [eslint.org](https://eslint.org/) through ongoing engagement with the community. Website Team Members are given push access to the `eslint.org` GitHub repository and must abide by the project's [Contribution Guidelines](../developer-guide/contributing/).
33
34 Website Team Members:
35
36 * Are expected to work on public branches of the source repository and submit pull requests from that branch to the master branch.
37 * Are expected to delete their public branches when they are no longer necessary.
38 * Must submit pull requests for all changes.
39 * Have their work reviewed by Reviewers and TSC members before acceptance into the repository.
40 * May label and close website-related issues (see [Managing Issues](issues.html))
41 * May merge some pull requests (see [Managing Pull Requests](pullrequests.html))
42
43 To become a Website Team Member:
44
45 * One must have shown a willingness and ability to participate in the maintenance of [eslint.org](https://eslint.org/) as a team player. Typically, a potential Website Team Member will need to show that they have an understanding of the structure of the website and how it fits into the larger ESLint project's objectives and strategy.
46 * Website Team Members are expected to be respectful of every community member and to work collaboratively in the spirit of inclusion.
47 * Have submitted a minimum of 10 website-related pull requests. What's a website-related pull request? One that is made to the `eslint.org` repository or the `docs` directory in the `eslint` repository and requires little effort to accept because it's well documented and tested.
48
49 New Website Team Members can be nominated by any existing Website Team Member or Committer. Once they have been nominated, there will be a vote by the TSC members.
50
51 It is important to recognize that membership on the website team is a privilege, not a right. That privilege must be earned and once earned it can be removed by the TSC members by a standard TSC motion. However, under normal circumstances Website Team Members remain for as long as they wish to continue engaging with the project.
52
53 ### Committers
54
55 Committers are community members who have shown that they are committed to the continued development of the project through ongoing engagement with the community. Committers are given push access to the project's GitHub repos and must abide by the project's [Contribution Guidelines](../developer-guide/contributing/).
56
57 Committers:
58
59 * Are expected to work on public branches of the source repository and submit pull requests from that branch to the master branch.
60 * Are expected to delete their public branches when they are no longer necessary.
61 * Must submit pull requests for all changes.
62 * Have their work reviewed by TSC members before acceptance into the repository.
63 * May label and close issues (see [Managing Issues](issues.html))
64 * May merge some pull requests (see [Managing Pull Requests](pullrequests.html))
65
66 To become a Committer:
67
68 * One must have shown a willingness and ability to participate in the project as a team player. Typically, a potential Committer will need to show that they have an understanding of and alignment with the project, its objectives, and its strategy.
69 * Committers are expected to be respectful of every community member and to work collaboratively in the spirit of inclusion.
70 * Have submitted a minimum of 10 qualifying pull requests. What's a qualifying pull request? One that carries significant technical weight and requires little effort to accept because it's well documented and tested.
71
72 New Committers can be nominated by any existing Committer. Once they have been nominated, there will be a vote by the TSC members.
73
74 It is important to recognize that committership is a privilege, not a right. That privilege must be earned and once earned it can be removed by the TSC members by a standard TSC motion. However, under normal circumstances committership exists for as long as the Committer wishes to continue engaging with the project.
75
76 A Committer who shows an above-average level of contribution to the project, particularly with respect to its strategic direction and long-term health, may be nominated to become a reviewer, described below.
77
78 #### Process for Adding Committers
79
80 1. Send email congratulating the new committer and confirming that they would like to accept. This should also outline the responsibilities of a committer with a link to the maintainer guide.
81 1. Add the GitHub user to the "ESLint Team" team
82 1. Add committer email to the ESLint team mailing list
83 1. Invite to Discord team channel
84 1. Tweet congratulations to the new committer from the ESLint Twitter account
85
86 ### Reviewers
87
88 Reviewers are community members who have contributed a significant amount of time to the project through triaging of issues, fixing bugs, implementing enhancements/features, and are trusted community leaders.
89
90 Reviewers may perform all of the duties of Committers, and also:
91
92 * May merge external pull requests for accepted issues upon reviewing and approving the changes.
93 * May merge their own pull requests once they have collected the feedback they deem necessary. (No pull request should be merged without at least one Committer/Reviewer/TSC member comment stating they've looked at the code.)
94
95 To become a Reviewer:
96
97 * Work in a helpful and collaborative way with the community.
98 * Have given good feedback on others' submissions and displayed an overall understanding of the code quality standards for the project.
99 * Commit to being a part of the community for the long-term.
100 * Have submitted a minimum of 50 qualifying pull requests.
101
102 A Committer is invited to become a Reviewer by existing Reviewers and TSC members. A nomination will result in discussion and then a decision by the TSC.
103
104 #### Process for Adding Reviewers
105
106 1. Add the GitHub user to the "ESLint Reviewers" GitHub team
107 1. Tweet congratulations to the new Reviewer from the ESLint Twitter account
108
109 ### Technical Steering Committee (TSC)
110
111 The ESLint project is jointly governed by a Technical Steering Committee (TSC) which is responsible for high-level guidance of the project.
112
113 The TSC has final authority over this project including:
114
115 * Technical direction
116 * Project governance and process (including this policy)
117 * Contribution policy
118 * GitHub repository hosting
119
120 TSC seats are not time-limited. The size of the TSC can not be larger than five members. This size ensures adequate coverage of important areas of expertise balanced with the ability to make decisions efficiently.
121
122 The TSC may add additional members to the TSC by a standard TSC motion.
123
124 A TSC member may be removed from the TSC by voluntary resignation, by a standard TSC motion, or by missing four consecutive TSC meetings. In all cases, the TSC member will revert to Reviewer status unless they prefer Alumni status.
125
126 Changes to TSC membership should be posted in the agenda, and may be suggested as any other agenda item (see "TSC Meetings" below).
127
128 No more than 1/3 of the TSC members may be affiliated with the same employer. If removal or resignation of a TSC member, or a change of employment by a TSC member, creates a situation where more than 1/3 of the TSC membership shares an employer, then the situation must be immediately remedied by the resignation or removal of one or more TSC members affiliated with the over-represented employer(s).
129
130 TSC members have additional responsibilities over and above those of a Reviewer. These responsibilities ensure the smooth running of the project. TSC members are expected to review code contributions, approve changes to this document, manage the copyrights within the project outputs, and attend regular TSC meetings.
131
132 TSC members may perform all of the duties of Reviewers, and also:
133
134 * May release new versions of all ESLint projects.
135 * May participate in TSC meetings.
136 * May propose budget items.
137 * May propose new ESLint projects.
138
139 There is no specific set of requirements or qualifications for TSC members beyond those that are expected of Reviewers.
140
141 A Reviewer is invited to become a TSC member by existing TSC members. A nomination will result in discussion and then a decision by the TSC.
142
143 #### Process for Adding TSC Members
144
145 1. Add the GitHub user to the "ESLint TSC" GitHub team
146 1. Set the GitHub user to be have the "Owner" role for the ESLint organization
147 1. Send a welcome email with a link to the [maintainer guide](./) and instructions for npm 2FA.
148 1. Invite to the Discord TSC channel
149 1. Make the TSC member an admin on the ESLint team mailing list
150 1. Add the TSC member to the recurring TSC meeting event on Google Calendar
151 1. Add the TSC member as an admin to ESLint Twitter Account on Tweetdeck
152 1. Add the TSC member to the ESLint TSC mailing list as an "Owner"
153 1. Tweet congratulations to the new TSC member from the ESLint Twitter account
154
155 #### TSC Meetings
156
157 The TSC meets every other week in the TSC Meeting [Discord](https://eslint.org/chat) channel. The meeting is run by a designated moderator approved by the TSC.
158
159 Items are added to the TSC agenda which are considered contentious or
160 are modifications of governance, contribution policy, TSC membership,
161 or release process.
162
163 The intention of the agenda is not to approve or review all patches.
164 That should happen continuously on GitHub and be handled by the larger
165 group of Committers.
166
167 Any community member, Committer, or Reviewer can ask that something be added to
168 the next meeting's agenda by logging a GitHub Issue. Anyone can add the item to the agenda by adding
169 the "tsc agenda" tag to the issue.
170
171 Prior to each TSC meeting, the moderator will share the Agenda with
172 members of the TSC. TSC members can add any items they like to the
173 agenda at the beginning of each meeting. The moderator and the TSC
174 cannot veto or remove items.
175
176 No binding votes on TSC agenda items can take place without a quorum of
177 TSC members present in the meeting. Quorum is achieved when more than
178 half of the TSC members (minus non-attending members) are present.
179
180 The TSC may invite persons or representatives from certain projects to
181 participate in a non-voting capacity.
182
183 The moderator is responsible for summarizing the discussion of each
184 agenda item and sending it as a pull request after the meeting.
185
186 ## Consensus Seeking Process
187
188 The TSC follows a
189 [Consensus Seeking](https://en.wikipedia.org/wiki/Consensus-seeking_decision-making)
190 decision making model.
191
192 When an agenda item has appeared to reach a consensus, the moderator
193 will ask "Does anyone object?" as a final call for dissent from the
194 consensus.
195
196 If an agenda item cannot reach a consensus, a TSC member can call for
197 either a closing vote or a vote to table the issue to the next
198 meeting. The call for a vote must be approved by a majority of the TSC
199 or else the discussion will continue. Simple majority wins.
200
201 ----
202
203 This work is a derivative of [YUI Contributor Model](https://github.com/yui/yui3/wiki/Contributor-Model) and the [Node.js Project Governance Model](https://github.com/nodejs/node/blob/master/GOVERNANCE.md).
204
205 This work is licensed under a [Creative Commons Attribution-ShareAlike 2.0 UK: England & Wales License](https://creativecommons.org/licenses/by-sa/2.0/uk/).