Skip to content

Commit 93ae690

Browse files
d33bsgwaybio
andauthored
docs(maintainer): add maintainer governance docs (#487)
* docs(maintainer): add maintainer governance docs * add maintainer offboarding docs Co-Authored-By: Gregory Way <[email protected]> --------- Co-authored-by: Gregory Way <[email protected]>
1 parent 4f91fb9 commit 93ae690

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,30 @@ Please report unacceptable behavior to [email protected].
4646

4747
## How can I contribute?
4848

49+
### Roles and responsibilities
50+
51+
There are two primary roles with regards to developing Pycytominer:
52+
53+
- **Contributors**: individuals without direct commit access to the `main` branch who make contributions in the form of communication, issues, or pull requests. We welcome anyone interested in additions to the project to be a contributor.
54+
- **Maintainers**: individuals with direct commit access who make contributions as outlined by the contributors role and also have the ability to make commits on the `main` branch through the development process (for example, by merging pull requests).
55+
Maintainers are also involved with decision-making procedures and the technical roadmap for Pycytominer.
56+
57+
#### Becoming a maintainer
58+
59+
Maintainers are prior contributors who receive extended privileges based on a decision by existing maintainers.
60+
To become a Pycytominer maintainer you must be championed by an existing maintainer.
61+
The championing maintainer consults with other maintainers about the addition of the new maintainer.
62+
After the current maintainers have considered the qualifications of the new maintainer they communicate their preferences internally.
63+
If there are no vetos the champion maintainer will grant maintainer access to the new maintainer.
64+
65+
#### Maintainer offboarding
66+
67+
Maintainer access may be removed under the following circumstances:
68+
69+
- Voluntary step-down (when a maintainer no longer wishes to remain in that role)
70+
- In the unfortunate event of a maintainer's passing
71+
- Code of conduct violations (in addition to other procedures specified by the code of conduct itself)
72+
4973
### Bug reporting
5074

5175
We love hearing about use-cases when our software does not work.

0 commit comments

Comments
 (0)