Contributing.md

   1 # Express.js Community Contributing Guide 1.0
   2
   3 The goal of this document is to create a contribution process that:
   4
   5 * Encourages new contributions.
   6 * Encourages contributors to remain involved.
   7 * Avoids unnecessary processes and bureaucracy whenever possible.
   8 * Creates a transparent decision making process that makes it clear how
   9 contributors can be involved in decision making.
  10
  11 ## Vocabulary
  12
  13 * A **Contributor** is any individual creating or commenting on an issue or pull request.
  14 * A **Committer** is a subset of contributors who have been given write access to the repository.
  15 * A **Project Captain** is the lead maintainer of a repository.
  16 * A **TC (Technical Committee)** is a group of committers representing the required technical
  17 expertise to resolve rare disputes.
  18 * A **Triager** is a subset of contributors who have been given triage access to the repository.
  19
  20 ## Logging Issues
  21
  22 Log an issue for any question or problem you might have. When in doubt, log an issue, and
  23 any additional policies about what to include will be provided in the responses. The only
  24 exception is security disclosures which should be sent privately.
  25
  26 Committers may direct you to another repository, ask for additional clarifications, and
  27 add appropriate metadata before the issue is addressed.
  28
  29 Please be courteous and respectful. Every participant is expected to follow the
  30 project's Code of Conduct.
  31
  32 ## Contributions
  33
  34 Any change to resources in this repository must be through pull requests. This applies to all changes
  35 to documentation, code, binary files, etc. Even long term committers and TC members must use
  36 pull requests.
  37
  38 No pull request can be merged without being reviewed.
  39
  40 For non-trivial contributions, pull requests should sit for at least 36 hours to ensure that
  41 contributors in other timezones have time to review. Consideration should also be given to
  42 weekends and other holiday periods to ensure active committers all have reasonable time to
  43 become involved in the discussion and review process if they wish.
  44
  45 The default for each contribution is that it is accepted once no committer has an objection.
  46 During a review, committers may also request that a specific contributor who is most versed in a
  47 particular area gives a "LGTM" before the PR can be merged. There is no additional "sign off"
  48 process for contributions to land. Once all issues brought by committers are addressed it can
  49 be landed by any committer.
  50
  51 In the case of an objection being raised in a pull request by another committer, all involved
  52 committers should seek to arrive at a consensus by way of addressing concerns being expressed
  53 by discussion, compromise on the proposed change, or withdrawal of the proposed change.
  54
  55 If a contribution is controversial and committers cannot agree about how to get it to land
  56 or if it should land then it should be escalated to the TC. TC members should regularly
  57 discuss pending contributions in order to find a resolution. It is expected that only a
  58 small minority of issues be brought to the TC for resolution and that discussion and
  59 compromise among committers be the default resolution mechanism.
  60
  61 ## Becoming a Triager
  62
  63 Anyone can become a triager! Read more about the process of being a triager in
  64 [the triage process document](Triager-Guide.md).
  65
  66 [Open an issue in `expressjs/express` repo](https://github.com/expressjs/express/issues/new)
  67 to request the triage role. State that you have read and agree to the
  68 [Code of Conduct](Code-Of-Conduct.md) and details of the role.
  69
  70 Here is an example issue content you can copy and paste:
  71
  72 ```
  73 Title: Request triager role for <your GitHub username>
  74
  75 I have read and understood the project's Code of Conduct.
  76 I also have read and understood the process and best practices around Express triaging.
  77
  78 I request for a triager role for the following GitHub organizations:
  79
  80 jshttp
  81 pillarjs
  82 express
  83 ```
  84
  85 Once you have opened your issue, a member of the TC will add you to the `triage` team in
  86 the organizations requested. They will then close the issue.
  87
  88 Happy triaging!
  89
  90 ## Becoming a Committer
  91
  92 All contributors who land a non-trivial contribution should be on-boarded in a timely manner,
  93 and added as a committer, and be given write access to the repository.
  94
  95 Committers are expected to follow this policy and continue to send pull requests, go through
  96 proper review, and have other committers merge their pull requests.
  97
  98 ## TC Process
  99
 100 The TC uses a "consensus seeking" process for issues that are escalated to the TC.
 101 The group tries to find a resolution that has no open objections among TC members.
 102 If a consensus cannot be reached that has no objections then a majority wins vote
 103 is called. It is also expected that the majority of decisions made by the TC are via
 104 a consensus seeking process and that voting is only used as a last-resort.
 105
 106 Resolution may involve returning the issue to project captains with suggestions on
 107 how to move forward towards a consensus. It is not expected that a meeting of the TC
 108 will resolve all issues on its agenda during that meeting and may prefer to continue
 109 the discussion happening among the project captains.
 110
 111 Members can be added to the TC at any time. Any TC member can nominate another committer
 112 to the TC and the TC uses its standard consensus seeking process to evaluate whether or
 113 not to add this new member. The TC will consist of a minimum of 3 active members and a
 114 maximum of 10. If the TC should drop below 5 members the active TC members should nominate
 115 someone new. If a TC member is stepping down, they are encouraged (but not required) to
 116 nominate someone to take their place.
 117
 118 TC members will be added as admin's on the Github orgs, npm orgs, and other resources as
 119 necessary to be effective in the role.
 120
 121 To remain "active" a TC member should have participation within the last 12 months and miss
 122 no more than six consecutive TC meetings. Our goal is to increase participation, not punish
 123 people for any lack of participation, this guideline should be only be used as such
 124 (replace an inactive member with a new active one, for example). Members who do not meet this
 125 are expected to step down. If A TC member does not step down, an issue can be opened in the
 126 discussions repo to move them to inactive status. TC members who step down or are removed due
 127 to inactivity will be moved into inactive status.
 128
 129 Inactive status members can become active members by self nomination if the TC is not already
 130 larger than the maximum of 10. They will also be given preference if, while at max size, an
 131 active member steps down.
 132
 133 ## Project Captains
 134
 135 The Express TC can designate captains for individual projects/repos in the
 136 organizations. These captains are responsible for being the primary
 137 day-to-day maintainers of the repo on a technical and community front.
 138 Repo captains are empowered with repo ownership and package publication rights.
 139 When there are conflicts, especially on topics that effect the Express project
 140 at large, captains are responsible to raise it up to the TC and drive
 141 those conflicts to resolution. Captains are also responsible for making sure
 142 community members follow the community guidelines, maintaining the repo
 143 and the published package, as well as in providing user support.
 144
 145 Like TC members, Repo captains are a subset of committers.
 146
 147 To become a captain for a project the candidate is expected to participate in that
 148 project for at least 6 months as a committer prior to the request. They should have
 149 helped with code contributions as well as triaging issues. They are also required to
 150 have 2FA enabled on both their GitHub and npm accounts. Any TC member or existing
 151 captain on the repo can nominate another committer to the captain role, submit a PR to
 152 this doc, under `Current Project Captains` section (maintaining the sort order) with
 153 the project, their GitHub handle and npm username (if different). The PR will require
 154 at least 2 approvals from TC members and 2 weeks hold time to allow for comment and/or
 155 dissent.  When the PR is merged, a TC member will add them to the proper GitHub/npm groups.
 156
 157 ### Current Project Captains
 158
 159 - `expressjs/express`: @wesleytodd
 160 - `expressjs/discussions`: @wesleytodd
 161 - `expressjs/expressjs.com`: @crandmck
 162 - `expressjs/body-parser`: @wesleytodd
 163 - `expressjs/multer`: @LinusU
 164 - `expressjs/cookie-parser`: @wesleytodd
 165 - `expressjs/generator`: @wesleytodd
 166 - `expressjs/statusboard`: @wesleytodd
 167 - `pillarjs/encodeurl`: @blakeembrey
 168 - `pillarjs/path-to-regexp`: @blakeembrey
 169 - `pillarjs/router`: @dougwilson, @wesleytodd
 170 - `pillarjs/finalhandler`: @wesleytodd
 171 - `pillarjs/request`: @wesleytodd
 172 - `jshttp/http-errors`: @wesleytodd
 173 - `jshttp/cookie`: @wesleytodd
 174 - `jshttp/on-finished`: @wesleytodd
 175 - `jshttp/forwarded`: @wesleytodd
 176 - `jshttp/proxy-addr`: @wesleytodd