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

We don't have maintainer documentation #537

Closed
mfisher87 opened this issue Apr 20, 2024 · 4 comments · Fixed by #608
Closed

We don't have maintainer documentation #537

mfisher87 opened this issue Apr 20, 2024 · 4 comments · Fixed by #608
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@mfisher87
Copy link
Member

mfisher87 commented Apr 20, 2024

#521 proposed a maintainer doc, but that would be an addition, not a refactor. This ticket is for the new documentation.

Related: #529 , #573

  • How to become a maintainer or triager?
    • Need better text, but something along the lines of be involved in our community and ask if you're interested.
    • Also, if you're interested in helping managing issues with labels and interacting with incoming requests, you can have a "triager" role!
  • What is required of maintainers?
  • What processes do maintainers follow beyond regular contributing processes?
    • Labeling. Specifically call out "good first issue"
    • Creating welcoming environment when communicating with contributors (issue / PR / discussion posters).
    • Reviewing and merging.
    • Releasing (documented in contributor guide already, we should move in to the maintainer guide).
  • ???
@mfisher87 mfisher87 added the documentation Improvements or additions to documentation label Apr 20, 2024
@mfisher87 mfisher87 changed the title New maintainer doc We don't have maintainer documentation Apr 20, 2024
@Sherwin-14
Copy link
Contributor

Sherwin-14 commented Jun 12, 2024

Hey are we looking at something similar to this https://www.pygmt.org/dev/maintenance.html?

@mfisher87
Copy link
Member Author

That looks amazing. In addition to answering the questions above (I'll add a bit of prose to the issue description), that maintainer guide includes the policy we're considering adopting in #573 , so we could knock both issues down at once here.

@chuckwondo
Copy link
Collaborator

That looks amazing. In addition to answering the questions above (I'll add a bit of prose to the issue description), that maintainer guide includes the policy we're considering adopting in #573 , so we could knock both issues down at once here.

They even have a more detailed page regarding Minimum Supported Versions

@mfisher87 mfisher87 linked a pull request Jul 9, 2024 that will close this issue
@mfisher87
Copy link
Member Author

We now have a maintainer doc thanks to @Sherwin-14's amazing work! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants