Skip to content

Commit cd32454

Browse files
authored
docs(contrib): add GOVERNANCE and MAINTAINERS files (#2938)
1 parent c558647 commit cd32454

File tree

2 files changed

+141
-0
lines changed

2 files changed

+141
-0
lines changed

docs/GOVERNANCE.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# Governance
2+
3+
## Making decisions
4+
5+
There's two main pieces to the way decisions are made in hyper:
6+
7+
1. A decision-making framework
8+
2. The people who apply it
9+
10+
The people are described [lower down in this document](#roles).
11+
12+
### Decision-making framework
13+
14+
We start with the users. The project wouldn't exist without them, and it exists
15+
in order to enable users to do amazing things with HTTP. We listen to our
16+
users. Some actively contribute their thoughts, but many others we must seek
17+
out to learn about their usage, joys, and headaches. Those insights allow our
18+
experts to determine the best solutions for the users.
19+
20+
We then define a set of [TENETS](./TENETS.md), which are guiding principles
21+
that can be used to measure aspects of individual decisions. It should be
22+
possible to identify one or more tenets that apply to why a decision is made.
23+
And the set helps us balance which priorities are more important for our users.
24+
25+
We combine the usecases with the tenets to come up with a [VISION](./VISION.md)
26+
that provides a longer-term plan of what hyper _should_ look like.
27+
28+
Finally, we define a [ROADMAP](./ROADMAP.md) that describes what the
29+
short-term, tactical changes to bring hyper closer in line with the vision.
30+
31+
## Roles
32+
33+
These are the roles people can fill when participating in the project. A list
34+
of the people in each role is available in [MAINTAINERS](./MAINTAINERS.md).
35+
36+
### Contributor
37+
38+
A contributor is anyone who contributes their time to provide value for the
39+
project. This could be in the form of code, documentation, filing issues,
40+
discussing designs, or helping others on the issue tracker or in chat.
41+
42+
All contributors MUST follow the [Code of Conduct][coc].
43+
44+
👋 **New here?** [This could be you!][contrib]
45+
46+
47+
### Triager
48+
49+
Triagers assess issues on the issue tracker. They help make sure the work is
50+
well organized, and are critical for making new issue reporters feeling
51+
welcome.
52+
53+
Responsibilities:
54+
55+
- Adhere to the [Code of Conduct][coc]
56+
- Follow the [triager's guide][triage-guide]
57+
58+
Privileges:
59+
60+
- Can edit, label, and close issues
61+
- Member of the organization
62+
- Can be assigned issues and pull requests
63+
64+
How to become:
65+
66+
- Make a few [contributions][contrib] to the project, to show you can follow
67+
the [Code of Conduct][coc].
68+
- Self-nominate by making a pull request adding yourself to the
69+
[list](./MAINTAINERS.md#triagers).
70+
71+
72+
### Collaborator
73+
74+
Collaborators are contributors who have been helping out in a consistent basis.
75+
76+
Responsibilities:
77+
78+
- Be exemplars of the [Code of Conduct][coc]
79+
- Internalize the [VISION](./VISION.md)
80+
- Reviewing pull requests from other contributors
81+
- Provide feedback on proposed features and design documents
82+
- [Welcome new contributors][triage-guide]
83+
- Answer questions in issues and/or chat
84+
- Mentor contributors to become members
85+
86+
Privileges:
87+
88+
- Can review and merge pull requests
89+
- Can trigger re-runs of CI, and approve CI for first-time contributors
90+
- Can assign issues and pull requests to other organization members
91+
92+
How to become:
93+
94+
- Work at fulfilling the above responsibilities.
95+
- Any collaborator may nominate a contributor who has been around for some time
96+
and is already filling the responsibilities.
97+
- Another collaborator must second the nomination.
98+
- If there are no objections, a maintainer will welcome the new collaborator.
99+
100+
Don't be afraid to ask a collaborator for what you could work on to reach this
101+
goal!
102+
103+
### Maintainer
104+
105+
Maintainers are the project admins. Besides being a collaborator, they take care
106+
house-keeping duties, help lead the direction, and have the final authority when
107+
required.
108+
109+
[coc]: ./CODE_OF_CONDUCT.md
110+
[contrib]: ../CONTRIBUTING.md
111+
[triage-guide]: ./ISSUES.md#triaging

docs/MAINTAINERS.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# The People
2+
3+
To see what these roles do, and how to become one, look at [GOVERNANCE](./GOVERNANCED.md).
4+
5+
## Triagers
6+
7+
## Collaborators
8+
9+
- Sean McArthur (@seanmonstar)
10+
- Steven Fackler (@sfackler)
11+
- Oliver Gould (@olix0r)
12+
- Eliza Weisman (@hawkw)
13+
- Lucio Franco (@LucioFranco)
14+
- Anthony Ramine (@nox)
15+
- David Pedersen (@davidpdrsn)
16+
- Adam Foltzer (@acfoltzer)
17+
18+
<details>
19+
<summary>Emeriti</summary>
20+
21+
### Collaborator emeriti
22+
23+
- Jonathan Reem (@reem)
24+
- Carl Lerche (@carllerche)
25+
26+
</details>
27+
28+
## Maintainers
29+
30+
- Sean McArthur (@seanmonstar)

0 commit comments

Comments
 (0)