Skip to content

Commit

Permalink
Update governance/contributing docs
Browse files Browse the repository at this point in the history
Summary: As we move away from JIRA to public Github, we need to update our documents to better reflect our new tooling.

Test Plan: These are just documents, so does not need to be tested.

Reviewers: vihang, zasgar

Reviewed By: zasgar

Signed-off-by: Michelle Nguyen <michellenguyen@pixielabs.ai>

Differential Revision: https://phab.corp.pixielabs.ai/D12221

GitOrigin-RevId: 53d28b2bfd4edb642883b698c92619fbfd9c8196
  • Loading branch information
aimichelle authored and copybaranaut committed Sep 19, 2022
1 parent 39b96ee commit 490e082
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 15 deletions.
7 changes: 0 additions & 7 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,6 @@
# Individual's name <submission email address>
# Individual's name <submission email address> [alias] <email2> [alias] <emailN>
#
# If you wish to keep your @pixielabs.ai (or @newrelic.com) address hidden,
# please still list <@pixielabs.ai> (or @newrelic) (with no user name)
# in the list of aliases.
#
# (Note: there is no point in hiding it if it is mentioned
# in the git log already.)
#
# For more details about the format, see git-check-mailmap(1)
#
# Please keep the list sorted.
Expand Down
4 changes: 0 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,6 @@ Before reporting a bug, we encourage you to search the existing Github issues to

The project is still in its early stages, and we are a small team actively working on delivering our roadmap. For all changes, regardless of size, please create a Github issue that details the bug or feature being addressed before submitting a pull request. In the Github issue, contributors may discuss the viability of the solution, alternatives, and considerations.

#### Contribution Roadmap

As we are still an early-stage open source project, more changes to the contribution guidelines will follow in the coming months. We are actively working on opening our JIRA for issue tracking.

#### Contribution Flow

1. Steps to making a code contribution to Pixie will generally look like the following:
Expand Down
8 changes: 4 additions & 4 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# The Project
Pixie (The Project) is an open source software project. The goal of The Project is to develop open source software and enable out-of-the-box visibility into developer’s Kubernetes applications. The Software developed by The Project is released under the Apache 2.0 license and is developed openly and hosted in public Github/Phabricator Repositories under the PixieLabs organization. Examples of Project Software include the Pixie core library, Pixie Python API, Pixie Go API, and Pixie documentation.
Pixie (The Project) is an open source software project. The goal of The Project is to develop open source software and enable out-of-the-box visibility into developer’s Kubernetes applications. The Software developed by The Project is released under the Apache 2.0 license and is developed openly and hosted in public Github Repositories under the pixie-io organization. Examples of Project Software include the Pixie core library, Pixie Python API, Pixie Go API, and Pixie documentation.

The Project is developed by a distributed team of developers, called Contributors. Contributors are individuals who have contributed code, documentation, designs, user support, or other work to one or more Project repositories. Anyone can be a Contributor. Contributors can be affiliated with any legal entity or none. Contributors participate in the project by submitting, reviewing and discussing Code Contributions and Issues and participating in open and public Project discussions on GitHub, JIRA, Phabricator, Slack, and mailing lists. The foundations of Project participation are openness and transparency.
The Project is developed by a distributed team of developers, called Contributors. Contributors are individuals who have contributed code, documentation, designs, user support, or other work to one or more Project repositories. Anyone can be a Contributor. Contributors can be affiliated with any legal entity or none. Contributors participate in the project by submitting, reviewing and discussing Code Contributions and Issues and participating in open and public Project discussions on GitHub, Slack, and mailing lists. The foundations of Project participation are openness and transparency.

[Here](https://github.com/pixie-io/pixie/blob/main/AUTHORS) is a list of some code Contributors to the main Pixie repository.

Expand Down Expand Up @@ -61,12 +61,12 @@ It is expected that the Governance Board and BDFL will be employed at a wide ran
All members of the Governance Board, BDFL included, shall disclose to the rest of the Board any conflict of interest they may have. If the BDFL has recused themselves for a particular decision, they will appoint the deputy BDFL for that decision. If the deputy BDFL has also recused themselves for that decision, they will appoint a substitute BDFL.

## Voting
In general, the Board makes decisions by lazy consensus with a minimum of participation based on the importance of the decisions to be made. Conversations happen on public GitHub or JIRA issues for most cases, and through private e-mail for more sensitive issues.
In general, the Board makes decisions by lazy consensus with a minimum of participation based on the importance of the decisions to be made. Conversations happen on public GitHub for most cases, and through private e-mail for more sensitive issues.

To make a decision the Board discusses the topic, a proposal is made, and a suitable wait time occurs for Board members to either agree or veto. By consensus we mean that any Board member can veto a decision with justification. By lazy we mean that not all Board members must participate, and that absence is interpreted as assent. By a minimum of participation we mean that we require the participation of a certain number of individuals based on the importance of the issue; for non-contentious issues a single Board member may move forward after a suitable time, while for contentious issues we will often require a few, often from different institutions.

## Private communications of the Board
Unless specifically required, all Board discussions and activities will be public and done in collaboration and discussion with the Project Contributors and Community. The Board will have a private mailing list that will be used sparingly and only when a specific matter requires privacy. When private communications and decisions are needed, the Board will do its best to summarize those to the Community after eliding personal/private/sensitive information that should not be posted to the public internet.

# Changing the Governance Documents
Changes to the governance documents are submitted via a GitHub/Phabricator pull request to The Project's governance document. The pull request is then refined in response to public comment and review, with the goal being consensus in the community. Since the BDFL holds ultimate authority in The Project, the BDFL has authority to act alone in accepting or rejecting changes.
Changes to the governance documents are submitted via a GitHub pull request to The Project's governance document. The pull request is then refined in response to public comment and review, with the goal being consensus in the community. Since the BDFL holds ultimate authority in The Project, the BDFL has authority to act alone in accepting or rejecting changes.

0 comments on commit 490e082

Please sign in to comment.