Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(maintainer): add maintainer governance docs #487

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Dec 9, 2024

Description

This PR adds documentation covering project roles and how to become a maintainer.

Closes #328

What is the nature of your change?

  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • New and existing unit tests pass locally with my changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

@d33bs d33bs marked this pull request as ready for review December 9, 2024 15:13
@d33bs d33bs requested review from gwaybio and kenibrewer December 9, 2024 15:13
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.74%. Comparing base (b558b39) to head (7ce8e1c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #487   +/-   ##
=======================================
  Coverage   94.74%   94.74%           
=======================================
  Files          57       57           
  Lines        3156     3156           
=======================================
  Hits         2990     2990           
  Misses        166      166           
Flag Coverage Δ
unittests 94.74% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@gwaybio gwaybio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the language additions here. I wonder if we should include a maintainer offboarding process as well.

I imagine this would be a voluntary decision, but are there any other scenarios that we should delineate for offboarding?

@d33bs
Copy link
Member Author

d33bs commented Dec 13, 2024

Thanks @gwaybio ! Good thoughts on adding an offboarding process. I imagine you're correct - that this would usually be a voluntary process. While a bit dark, another scenario might be if we know someone has passed away (we might want to demote the account to help avoid unwanted activity should their account be hijacked).

We could get more thorough here and think through if we want to remove maintainers based on inactivity, but I don't know how to make that process fair and useful at this time. PEP 13 highlights an ejection process that might be helpful; maybe we could adopt something like this to be on the safe side (two-thirds vote to eject from other existing maintainers means involuntary offboarding of maintainer status within Pycytominer). We could peel this off into another issue for further discussion. Thoughts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc: How we grant/revoke maintainer status
3 participants