search

GenericMappingTools / pygmt

A Python interface for the Generic Mapping Tools.
https://www.pygmt.org
BSD 3-Clause "New" or "Revised" License
758 stars 220 forks source link

Adding a PyGMT team page #1212

Closed maxrjones closed 6 months ago

maxrjones commented 3 years ago

Background information:

  1. It could be helpful for new contributors to know who the PyGMT maintainers are, now that the list of maintainers is growing.
  2. I am working on improving the authorship guidelines and acknowledgements structure for GMT (see https://github.com/GenericMappingTools/gmt/issues/2330 for context) and envision one of the products being similar to the Numpy team gallery, which could be hosted at www.generic-mapping-tools.org with a link from the about page. PyGMT maintainers could be included on that page, as an option.

So here are my questions regarding PyGMT specifically:

  1. Do people think it would be helpful to publicly list the PyGMT maintainers?
  2. Are maintainers comfortable with being included on some sort of team page? (this could be discussed on slack)
  3. If so, should this be done on the same page as the GMT teams or a separate page? If it's a separate page, should it be hosted on www.generic-mapping-tools.org or elsewhere?

Originally posted in https://github.com/GenericMappingTools/pygmt/issues/1113#issuecomment-805343339.

willschlitzer commented 3 years ago 
1. Do people think it would be helpful to publicly list the PyGMT maintainers?

Yes, I think it's a good way to demonstrate to people coming to the project that they can contribute, as it puts a face on the people they are interacting with. I think seeing that we're not all computer scientists encourages people who may doubt they have the skills and experience to work on the project.

2. Are maintainers comfortable with being included on some sort of team
page? (this could be discussed on slack)

For me personally, yes.

3. If so, should this be done on the same page as the GMT teams or a separate page? 
If it's a separate page, should it be hosted on www.generic-mapping-tools.org or elsewhere?

Why wouldn't this be on the PyGMT page? I think that would make more sense to someone coming to the project, as our goal is to improve our wrapper and documentation until users need only be familiar with PyGMT and not have to refer back to GMT documentation to learn the correct syntax.

maxrjones commented 3 years ago

Why wouldn't this be on the PyGMT page? I think that would make more sense to someone coming to the project, as our goal is to improve our wrapper and documentation until users need only be familiar with PyGMT and not have to refer back to GMT documentation to learn the correct syntax.

I had been looking at organizations like project Jupyter and Numpy when considering options for the placement of the teams page. For those projects, information about teams are on the organization webpages (https://jupyter.org/about and https://numpy.org/gallery/team.html) rather than inside the reference documentation for the packages (https://jupyter.readthedocs.io/en/latest/ and https://numpy.org/doc/stable/). I viewed https://www.generic-mapping-tools.org/ as the most analogous place for GMT (and possibly PyGMT/GMT-MEX/GMT.jl) teams, rather than inside the reference documentation (i.e., https://docs.generic-mapping-tools.org/latest/ and https://www.pygmt.org/latest/).

seisman commented 3 years ago

Please note that the link https://www.generic-mapping-tools.org/team is already taken and is redirected to the https://github.com/GenericMappingTools/gmt/blob/master/AUTHORS.md file.

seisman commented 6 months ago

I'm reopening the 3-year-old issue to post some thoughts on the "Team Gallery" page:

  1. Rename the page title from "Team Gallery" to "PyGMT Team" or "Team"
  2. Currently, everyone is listed under the "Distinguished Contributors" section. Maybe we should have sections like "Founders", "Current Active Maintainers" and "Distinguished Contributors"?
  3. Maintainers may be inactive due to lacking of time or interest and should be removed. Currently, we only mention that "New Distinguished Contributors are selected twice per year by those listed below." What's the policy for removing a maintainer? Maybe move from "Maintainers" to "Contributors" if someone is inactive for one year? Of course, inactive maintainers are welcome back at any time.
  4. We should add a reminder in the Release checklist issue template, so that we don't forget to update the team gallery.

References:

  1. https://numpy.org/teams/
  2. https://pandas.pydata.org/about/team.html
  3. https://xarray.dev/team

Ping @GenericMappingTools/pygmt-maintainers for thoughts.

yvonnefroehlich commented 6 months ago

I'm reopening the 3-year-old issue to post some thoughts on the "Team Gallery" page:

  1. Rename the page title from "Team Gallery" to "PyGMT Team" or "Team"

"PyGMT Team" as title sounds good to me.

  1. Currently, everyone is listed under the "Distinguished Contributors" section. Maybe we should have sections like "Founders", "Current Active Maintainers" and "Distinguished Contributors"?

I am fine with having different sections related to the different roles. What's about "Core Developer"? However, we should not have more then four / five sections, as there are currently ten people listed on the Team Gallery page.

  1. Maintainers may be inactive due to lacking of time or interest and should be removed. Currently, we only mention that "New Distinguished Contributors are selected twice per year by those listed below." What's the policy for removing a maintainer? Maybe move from "Maintainers" to "Contributors" if someone is inactive for one year? Of course, inactive maintainers are welcome back at any time.

pandas separates between "active maintainers" and "inactive maintainers". One year sounds fair to me. How do we want to define inactive?

  1. We should add a reminder in the Release checklist issue template, so that we don't forget to update the team gallery.

This makes sense :grimacing:.

seisman commented 6 months ago
  1. Currently, everyone is listed under the "Distinguished Contributors" section. Maybe we should have sections like "Founders", "Current Active Maintainers" and "Distinguished Contributors"?

I am fine with having different sections related to the different roles. What's about "Core Developer"? However, we should not have more then four / five sections, as there are currently ten people listed on the Team Gallery page.

Yes, I agree. I also prefer to not list one person in multiple sections.

  1. Maintainers may be inactive due to lacking of time or interest and should be removed. Currently, we only mention that "New Distinguished Contributors are selected twice per year by those listed below." What's the policy for removing a maintainer? Maybe move from "Maintainers" to "Contributors" if someone is inactive for one year? Of course, inactive maintainers are welcome back at any time.

pandas separates between "active maintainers" and "inactive maintainers". One year sounds fair to me. How do we want to define inactive?

Maintainers are contributors with more permissions and more responsibilities (tasks listed in https://www.pygmt.org/dev/maintenance.html). A maintainer should be marked as "inactive" if he/she no longer manage issues, review PRs, manage releases and participate in discussions.

yvonnefroehlich commented 6 months ago

Just tried two variants:

three sections five sections
teampage_threesections teampage_fivesections
seisman commented 6 months ago

I prefer the left one with three sections. I think we just need to add a few sentences explaining that distinguished contributors include current or past contributors and past maintainers.

yvonnefroehlich commented 6 months ago

I submitted PR #3240 for the three-sections variant.