Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 4.21 KB

CONTRIBUTING.md

File metadata and controls

81 lines (59 loc) · 4.21 KB

Node.js Community Contributing Guide 1.0

Code of Conduct

The Code of Conduct explains the bare minimum behavior expectations the Node Foundation requires of its contributors. Please read it before participating.

Vocabulary

  • A Contributor is any individual creating or commenting on an issue or pull request.
  • A Collaborator is a subset of contributors who have been given write access to the repository.
  • A WG (Working Group) is a group of collaborators representing the required technical expertise to resolve rare disputes.

Logging Issues

Log an issue for any question or problem you might have. When in doubt, log an issue, any additional policies about what to include will be provided in the responses. The only exception is security disclosures which should be sent privately.

Collaborators may direct you to another repository, ask for additional clarifications, and add appropriate metadata before the issue is addressed.

Please be courteous, respectful, and every participant is expected to follow the project's Code of Conduct.

Contributions

Any change to resources in this repository must be through pull requests. This applies to all changes to documentation, code, binary files, etc. Even long term collaborators and WG members must use pull requests.

No pull request can be merged without being reviewed.

For non-trivial contributions, pull requests should sit for at least 36 hours to ensure that contributors in other timezones have time to review. Consideration should also be given to weekends and other holiday periods to ensure active collaborators all have reasonable time to become involved in the discussion and review process if they wish.

The default for each contribution is that it is accepted once no collaborator has an objection. During review collaborators may also request that a specific contributor who is most versed in a particular area gives a "LGTM" before the PR can be merged. There is no additional "sign off" process for contributions to land. Once all issues brought by collaborators are addressed it can be landed by any collaborator.

In the case of an objection being raised in a pull request by another collaborator, all involved collaborators should seek to arrive at a consensus by way of addressing concerns being expressed by discussion, compromise on the proposed change, or withdrawal of the proposed change.

If a contribution is controversial and collaborators cannot agree about how to get it to land or if it should land then it should be escalated to the WG. WG members should regularly discuss pending contributions in order to find a resolution. It is expected that only a small minority of issues be brought to the WG for resolution and that discussion and compromise among collaborators be the default resolution mechanism.

Becoming a Collaborator

All contributors who land a non-trivial contribution should be on-boarded in a timely manner, and added as a collaborator, and be given write access to the repository.

Collaborators are expected to follow this policy and continue to send pull requests, go through proper review, and have other collaborators merge their pull requests.

WG Process

The WG uses a "consensus seeking" process for issues that are escalated to the WG. The group tries to find a resolution that has no open objections among WG members. If a consensus cannot be reached that has no objections then a majority wins vote is called. It is also expected that the majority of decisions made by the WG are via a consensus seeking process and that voting is only used as a last-resort.

Resolution may involve returning the issue to collaborators with suggestions on how to move forward towards a consensus. It is not expected that a meeting of the WG will resolve all issues on its agenda during that meeting and may prefer to continue the discussion happening among the collaborators.

Members can be added to the WG at any time. Any collaborator can nominate another collaborator to the WG and the WG uses its standard consensus seeking process to evaluate whether or not to add this new member. Members who do not participate consistently at the level of a majority of the other members are expected to resign.