Skip to content

Commit

Permalink
Update emails, links, and PegaSys references (#190)
Browse files Browse the repository at this point in the history
* Update emails, links, and PegaSys references

Signed-off-by: Tim Beiko <t.beiko23@gmail.com>

* Update COMMUNITY_MEMBERSHIP.md

Signed-off-by: Tim Beiko t.beiko23@gmail.com

Co-authored-by: Usman Saleem <usman@usmans.info>

Co-authored-by: Usman Saleem <usman@usmans.info>
  • Loading branch information
timbeiko and usmansaleem authored Sep 7, 2020
1 parent 7cd75a8 commit 280086f
Show file tree
Hide file tree
Showing 7 changed files with 184 additions and 16 deletions.
8 changes: 4 additions & 4 deletions CLA.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Sign the CLA
=============

This page is the step-by-step guide to signing the Consensys AG
Individual Contributor License Agreement.
This page is the step-by-step guide to signing the Consensys Software Inc.
Individual Contributor License Agreement.

1. First and foremost, read [the current version of the CLA].
1. First and foremost, read [the current version of the CLA].
It is written to be as close to plain English as possible.

2. Make an account on [GitHub] if you don't already have one.
Expand All @@ -13,6 +13,6 @@ Individual Contributor License Agreement.
pre-requisite requiring to you read and sign the CLA.

If you have any questions, you can reach us on [Gitter].

[GitHub]: https://github.com/
[the current version of the CLA]: https://gist.github.com/rojotek/978b48a5e8b68836856a8961d6887992
4 changes: 2 additions & 2 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [private@pegasys.tech]. All
reported by contacting the project team at [private-quorum@consensys.net]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand All @@ -71,4 +71,4 @@ This Code of Conduct is adapted from the [Contributor Covenant], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[Contributor Covenant]: https://www.contributor-covenant.org
[private@pegasys.tech]: mailto:private@pegasys.tech
[private-quorum@consensys.net]: mailto:private-quorum@consensys.net
2 changes: 1 addition & 1 deletion CODING-CONVENTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Web3Signer embraces typical Java idioms including using an Object Oriented appro
- Don't pass lambdas into executors because it makes it harder to identify the threading interactions. The lambda makes the code shorter but not clearer. Instead use a separate class or extract a method.
* For good examples, refer to the APIs the JDK itself exposes.

>**Note** If you're not sure what idiomatic Java looks like, start by following the typical patterns and naming used in this or other PegaSys codebases.
>**Note** If you're not sure what idiomatic Java looks like, start by following the typical patterns and naming used in this or other ConsenSys codebases.
## 2.3 You Ain't Gonna Need It (YAGNI)

Expand Down
167 changes: 167 additions & 0 deletions COMMUNITY_MEMBERSHIP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
# Community organisation and members responsibilities

This doc outlines the various responsibilities of contributor roles in
this project.

| Role | Responsibilities | Defined by |
|---------------------|----------------------------------------------|-----------------------------|
| Everyone | none | anybody with a belly button |
| Member | everyone who contributes - code or otherwise | Web3Signer GitHub org member |
| Approver | approve accepting contributions | write permissions on master |
| Project Manager | management of the project | ConsenSys |
| Project Sponsor | contribute developer resources | ConsenSys |
| Open Source Circle | OSS support | ConsenSys |
| Project Evangelist | promote the project | ConsenSys |
| Benevolent Dictator | decision tie-breaker | ConsenSys |

## Everyone
Any person from the public is able to access the code. The standard permissions grant the ability to view the code, view open bugs, access the wiki, download binaries, view CI results and comment on pull requests.

## New contributors

[New contributors] should be welcomed to the community by existing members,
helped with PR workflow, and directed to relevant documentation and
communication channels.

## Established community members

Established community members are expected to demonstrate their adherence to the
principles in this document, familiarity with project organization, roles,
policies, procedures, conventions, etc., and technical and/or writing ability.
Role-specific expectations, responsibilities, and requirements are enumerated
below.

## Member

Members are continuously active contributors in the community. They can have
issues and PRs assigned to them.

### Requirements

- Enabled [two-factor authentication] on their GitHub account
- Have made multiple contributions to the project or community. Contribution may include, but is not limited to:
- Authoring or reviewing PRs on GitHub
- Filing or commenting on issues on GitHub
- Contributing to community discussions (e.g. meetings, Slack, email discussion forums, Stack Overflow)
- Joined [Web3Signer Discord]
- Have read the [contributor guide]
- Signed ICLA, as described in [CLA.md]

### Responsibilities and privileges

- Responsive to issues and PRs assigned to them
- Active owner of code they have contributed (unless ownership is explicitly transferred)
- Code is well tested
- Tests consistently pass
- Addresses bugs or issues discovered after code is accepted
- Members can do `/lgtm` on open PRs
- They can be assigned to issues and PRs, and people can ask members for reviews with a `/cc @username`

## Approver

Code approvers are members that have signed an ICLA and have been granted additional commit privileges. While members are expected to provided code reviews that focus on code quality and correctness, approval is focused on holistic acceptance of a contribution including: backwards / forwards compatibility, adhering to API and flag conventions, subtle performance and correctness issues, interactions with other parts of the system, etc.

**Defined by:** write permissions on master branch

### Requirements

- Includes all of the requirements of a Member user
- Signed ICLA, as described in [CLA.md]
- Approver status granted by Project Sponsor or the Open Source Circle

### Responsibilities and privileges
- Includes all of the responsibilities and privileges of a Member user
- Approver status may be a precondition to accepting large code contributions
- Demonstrate sound technical judgement
- Responsible for project quality control via [code reviews]
- Focus on holistic acceptance of contribution such as dependencies with other features, backwards / forwards
compatibility, API and flag definitions, etc
- Expected to be responsive to review requests as per [community expectations]
- Mentor members
- May approve pull requests
- May merge pull requests

## Project Manager
The Project Manager role provides the user with control over management aspects of the project.

**Defined by:** ConsenSys

### Requirements
- Includes all of the requirements of a Member user
- Signed ICLA, as described in [CLA.md]
- PM status granted by Project Sponsor or the Open Source Circle

### Responsibilities and privileges
- Includes all of the responsibilities and privileges of a Member user
- Determining releases
- Managing roadmaps and access to Circle reports



## Project Sponsor
The Project Sponsor role provides a user with the ability to contribute additional developer resources to the project. Project Sponsors must sign the ICLA.

**Defined by:** ConsenSys

### Requirements
- Signed ICLA, as described in [CLA.md]
- Project Sponsor status granted by the Open Source Circle

### Responsibilities and privileges
- Includes all of the responsibilities and privileges of a Member user
- Approval of new users to the Approver role, and access to Circle reports.

## Open Source Circle
The Open Source Circle is a group that provides open source software support to projects.
**Defined by:** ConsenSys

### Requirements
- Includes all of the requirements of a Member user
- Signed ICLA, as described in [CLA.md]
- Open Source Circle status granted by the Open Source Circle

### Responsibilities and privileges
- Includes all of the responsibilities and privileges of a Project Sponsor
- Ability to archive the project
- Manage the CLA
- Conduct legal reviews

## Project Evangelist
The Project Evangelist role is for those who wish to promote the project to the outside world, but not actively contribute to it.
**Defined by:** ConsenSys

### Requirements
- Includes all of the requirements of a Member user
- Signed ICLA, as described in [CLA.md]
- Project Evangelist status granted by the Open Source Circle

### Responsibilities and privileges
- Includes all of the responsibilities and privileges of a Member user
- Project Evangelist have the standard public access permissions
- Organise talks
- Work with marketing to manage web and graphical assets

## Benevolent Dictator
The benevolent dictator, or project lead, is self-appointed. However, because the community always has the ability to fork, this person is fully answerable to the community. The key is to ensure that, as the project expands, the right people are given influence over it and the community rallies behind the vision of the project lead.

### Responsibilities and privileges
- Set the strategic objectives of the project and communicate these clearly to the community
- Understand the community as a whole and strive to satisfy as many conflicting needs as possible, while ensuring that the project survives in the long term
- Ensure that the approvers make the right decisions on behalf of the project
- Provide final tie-breaker decisions when consensus cannot be reached.


## Attribution

This document is adapted from the following sources:
- Kubernetes community-membership.md, available at [kub community membership].
- OSSWatch Benevolent Dictator Governance Model, available at [oss watch benevolent dictator].

[CLA.md]: /CLA.md
[oss watch benevolent dictator]: http://oss-watch.ac.uk/resources/benevolentdictatorgovernancemodel
[kub community membership]: https://raw.githubusercontent.com/kubernetes/community/master/community-membership.md
[code reviews]: /docs/community/code-reviews.md
[contributor guide]: /CONTRIBUTING.md
[New contributors]: /CONTRIBUTING.md
[two-factor authentication]: https://help.github.com/articles/about-two-factor-authentication
[Web3Signer Discord]: /README.md#chat
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ and feel free to propose changes to this document in a pull request.
## Code of Conduct

This project and everyone participating in it is governed by the [Web3Signer Code of Conduct](CODE-OF-CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior to [private@pegasys.tech].
By participating, you are expected to uphold this code. Please report unacceptable behavior to [private-quorum@consensys.net].

## I just have a quick question

> **Note:** Please don't file an issue to ask a question. You'll get faster results by using the resources below.
* [Web3Signer documentation]
* [Gitter]
* [Discord]

## How To Contribute
### Reporting Bugs
Expand Down Expand Up @@ -242,10 +242,10 @@ These are not strictly enforced during the build, but should be adhered to and c
| [`requires-changes`][search-label-requires-changes] | Pull requests which need to be updated based on review comments and then reviewed again. |
| [`needs engineering approval`][search-label-needs-engineering-approval] | Pull requests which need to be approved from a technical person, mainly documentation PRs. |

[private@pegasys.tech]: mailto:private@pegasys.tech
[Gitter]: https://gitter.im/PegaSysEng/web3signer
[private-quorum@consensys.net]: mailto:private-quorum@consensys.net
[Discord]: https://discord.gg/KMh2Mjh
[GitHub]: https://github.com/PegaSysEng/web3signer
[Web3Signer documentation]: https://docs.web3signer.pegasys.tech/
[Web3Signer documentation]: https://doc.eth2signer.pegasys.tech/en/latest/
[CLA.md]: /CLA.md
[Code Reviews]: /community/code-reviews.md
[MkDocs]: https://www.mkdocs.org/
Expand Down
4 changes: 2 additions & 2 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Overview
This project is led by a benevolent dictator (PegaSys) and managed by the community. That is, the
This project is led by a benevolent dictator (ConsenSys) and managed by the community. That is, the
community actively contributes to the day-to-day maintenance of the project, but the general
strategic line is drawn by the benevolent dictator. In case of disagreement, they have the last word.
It is the benevolent dictator’s job to resolve disputes within the community and to ensure that the
Expand Down Expand Up @@ -27,7 +27,6 @@ See [community membership]
Decision making will be handled by the Approvers (see [community membership]). If consensus cannot
be reached, the Benevolent Dictator will provide the final word on the decision.


# CLA

All contributors must sign the CLA, as described in [CLA.md].
Expand All @@ -40,6 +39,7 @@ This document was influenced by the following:

[CLA.md]: /CLA.md
[code of conduct]: /CODE-OF-CONDUCT.md
[community membership]: /COMMUNITY_MEMBERSHIP.md
[oss watch benevolent dictator]: http://oss-watch.ac.uk/resources/benevolentdictatorgovernancemodel
[kub community membership]: https://raw.githubusercontent.com/kubernetes/community/master/community-membership.md
[kub governance]:https://github.com/kubernetes/community/blob/master/governance.md
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,12 @@ See our [contribution guidelines](CONTRIBUTING.md) for more detail on searching
## Users
* [User documentation](https://docs.web3signer.pegasys.tech/)

## Chat
* [Discord server](https://discord.gg/KMh2Mjh)

## Developers
* [Contribution Guidelines](CONTRIBUTING.md)
* [Coding Conventions](CODING-CONVENTIONS.md)

## Release Notes
* [Release Notes](CHANGELOG.md)

[Gitter]: https://gitter.im/PegaSysEng/web3signer

0 comments on commit 280086f

Please sign in to comment.