Skip to content

Commit

Permalink
Added a page on policies for pants committers
Browse files Browse the repository at this point in the history
Documents some policies discussed at the last pants summit

Testing Done:
https://travis-ci.org/pantsbuild/pants/builds/146345308

Staged at http://pantsbuild.github.io/staging/zundel/committers.html

Bugs closed: 3707

Reviewed at https://rbcommons.com/s/twitter/r/4105/
  • Loading branch information
ericzundel committed Jul 24, 2016
1 parent 783feee commit cfae8f8
Show file tree
Hide file tree
Showing 5 changed files with 108 additions and 15 deletions.
28 changes: 28 additions & 0 deletions COMMITTERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Active Committers
=================

Andy Reitz
Nick Howard
Benjy Weinberger
Chris Heisterkamp
Matt Olsen
David Turner
Eric Ayers
Fedor Korotkov
Garrett Malmquist
Ity Kaul
John Sirois
Kris Wilson
Larry Hosken
Mateo Rodriguez
Patrick Lawson
Peiyu Want
Stu Hood
Tejal
Travis Crawford
Yi Cheng

Emeritus
========

David Taylor
38 changes: 23 additions & 15 deletions src/docs/BUILD
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
page(
name='1.0',
source='1.0.md',
)

page(
name='3rdparty',
source='3rdparty.md',
Expand All @@ -12,11 +17,6 @@ page(
source='announce_201409.md',
)

page(
name='1.0',
source='1.0.md',
)

page(
name='build_files',
source='build_files.md',
Expand All @@ -25,6 +25,12 @@ page(
]
)

page(
name='committers',
source='committers.md',
)


page(
name='community',
source='community.md',
Expand All @@ -49,6 +55,11 @@ page(
]
)

page(
name='ide_support',
source='ide_support.md',
)

page(
name='index',
source='index.md',
Expand Down Expand Up @@ -137,20 +148,11 @@ page(
]
)

page(
name='why_use_pants',
source='why_use_pants.md'
)

page(
name='ide_support',
source='ide_support.md',
)

page(
name='dev',
source='dev.md',
links=[
':committers',
':dev_tasks',
':dev_tasks_publish_extras',
':docs',
Expand Down Expand Up @@ -282,3 +284,9 @@ page(
':howto_contribute',
]
)

page(
name='why_use_pants',
source='why_use_pants.md'
)

55 changes: 55 additions & 0 deletions src/docs/committers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
Pants Committers
================

The Pants project welcomes contributions from all developers. In order to properly vet changes to the codebase, we have a review process and your code must be approved and committed to the repo by a developer with commit access to the pantsbuild github project.

A Committer is a member of the community who has access to commit changes to the master branch of the github repo. We limit the number of committers to developers who have a proven track record with contributing code changes and actively participate in the project through code contributions, reviews, and community discussions.

Becoming a Committer
--------------------

Nominations for committers are discussed on the [email protected] group. The discussion will consider commits contributed to date and the participation of the contributor in reviews and public communication channels. Feedback is gathered on what might be required for the contributor to be approved as a committer.

The minimum requirement to become a committer is evidence of at least 10 "significant contributions" to the open source repo. The definition of what constitutes a "significant contribution" is kept intentionally vague, but at a minimum, those contributions should:

- Include changes that impact code, test, and documentation.
- Be vetted by committers from multiple organizations.
- Cover more than a single area of the pants codebase.
- Demonstrate knowledge of and willingness to follow project development processes and procedures.

After approval by a vote of the current committers, a new committer has access to the following resources:

- Commit access to the github repo.
- Ability to Stop/restart builds on Travis-CI.
- An account on the code review site (RBCommons) that is part of the 'twitter’ team.
- Access to the [email protected] group.

A committer may also request access to publish changes to the org.pantsbuild groupId on the Maven Central Repository.

The list of current and past committers will be listed in a file named COMMITTERS.rb in the root of the pantsbuild/pants repo.

Committer Responsibilities
--------------------------

It is the responsibility of a Committer to ensure that the ongoing good health and high quality of the project is maintained.

- Committers are responsible for the quality of the changes that they approve.
- Committers should raise objections to changes that may impact the performance, security, or maintainability of the project.
- Committers should help shepherd changes from non-committers through our contribution process.
- Committers should maintain a courteous and professional demeanor when participating in the community.
- Committers should be regular participants on our public communications channels.

Committers should respond to public requests for code reviews. While it is not necessary for every review to be approved by every committer, the health of the community depends on quality vetting of incoming changes. If only a single committer is tagged on a review and is unable to participate, the committer should respond to the review and recommend another committer.

Releaser
--------

A Releaser is a Committer who has permission to publish releases to the pantsbuild.pants PyPi repository. A Committer who wishes to participate in the pants release rotation may additionally become a Releaser. A Releaser is responsible for updating the release documentation, creating release builds, and shepherding them through the review and release process.

Committer Emeritus
------------------

A committer may be placed on emeritus status. This is an honorary position for committers who were formerly active in the community but have retired from active Pants life. These committers do not have commit access to the repositories.

The decision to place a committer on emeritus status is either by request, or by majority vote of the committers. If you have not participated in code reviews or contributed a patch to pants within the past three months an automatic recommendation for emeritus status may be put forward to the committers.

1 change: 1 addition & 0 deletions src/docs/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,4 @@ how to get your change committed.
+ [[Release Strategy|pants('src/docs:release_strategy')]]
+ [[Deprecation Policy|pants('src/docs:deprecation_policy')]]
+ [[Updating the Docs|pants('src/docs:docs')]]
+ [[Pants Committers|pants('src/docs:committers')]]
1 change: 1 addition & 0 deletions src/docs/docsite.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"announce_201409": "dist/markdown/html/src/docs/announce_201409.html",
"build_dictionary": "dist/reference/build_dictionary_body.html",
"build_files": "dist/markdown/html/src/docs/build_files.html",
"committers" : "dist/markdown/html/src/docs/committers.html",
"changelog": "dist/markdown/html/src/python/pants/CHANGELOG.html",
"notes-master": "dist/markdown/html/src/python/pants/notes/master.html",
"notes-1.0.x": "dist/markdown/html/src/python/pants/notes/1.0.x.html",
Expand Down

0 comments on commit cfae8f8

Please sign in to comment.