-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
22f35b3
commit 936c3d9
Showing
1 changed file
with
58 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# ServerX Contribution Guide | ||
|
||
The goal of this document is to create a contribution process that: | ||
|
||
* Encourages new contributions. | ||
* Encourages contributors to remain involved. | ||
* Avoids unnecessary processes and bureaucracy whenever possible. | ||
* Creates a transparent decision making process that makes it clear how | ||
contributors can be involved in decision making. | ||
|
||
## Vocabulary | ||
|
||
* A **Contributor** is any individual creating or commenting on an issue or pull request. | ||
* A **Committer** is a subset of contributors who have been given write access to the repository. | ||
* A **TC (Technical Committee)** is a group of committers representing the required technical | ||
expertise to resolve rare disputes. | ||
* A **Triager** is a subset of contributors who have been given triage access to the repository. | ||
|
||
## Logging Issues | ||
|
||
Log an issue for any question or problem you might have. When in doubt, log an issue, and | ||
any additional policies about what to include will be provided in the responses. The only | ||
exception is security disclosures which should be sent privately. | ||
|
||
Committers may direct you to another repository, ask for additional clarifications, and | ||
add appropriate metadata before the issue is addressed. | ||
|
||
Please be courteous and respectful. 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 committers and TC 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 committers 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 committer has an objection. | ||
During a review, committers 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 committers are addressed it can | ||
be landed by any committer. | ||
|
||
In the case of an objection being raised in a pull request by another committer, all involved | ||
committers 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 committers cannot agree about how to get it to land | ||
or if it should land then it should be escalated to the TC. TC 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 TC for resolution and that discussion and | ||
compromise among committers be the default resolution mechanism. |