Skip to content

Clerical updates to governance #170

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

Open
wants to merge 5 commits into
base: stable
Choose a base branch
from
Open

Clerical updates to governance #170

wants to merge 5 commits into from

Conversation

powerjg
Copy link
Contributor

@powerjg powerjg commented Mar 13, 2025

This updates the governance document on the website to reflect that we are using github now. It also includes some small typological changes.

powerjg added 4 commits March 13, 2025 11:11
This change also replaces some uses of the mailing list with github discussions
When we used reviewboard (many, many years ago) the term for the person with the ability to modify the mainline code was "committer." Now that we are using github, we're using the term "maintainer." This commit makes that change to the governance file. Other minor reviewboard->github changes are also included.
Copy link
Contributor

@mattsinc mattsinc left a comment

Choose a reason for hiding this comment

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

A few minor things, but otherwise seems fine to me

A committer who shows an above-average level of contribution to the project, particularly with respect to its strategic direction and long-term health, may be nominated to become a member of the PMC. This role is described below.
A maintainer who shows an above-average level of contribution to the project, particularly with respect to its strategic direction and long-term health, may be nominated to become a member of the PMC. This role is described below.

Note: The definitive list of maintainers is kept via a GitHub Team and lists on the website, etc. may be out of date.
Copy link
Contributor

Choose a reason for hiding this comment

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

This note is somewhat word salad and I'm not sure how to parse it. Do we need to say where the GitHub Team is kept?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

GitHub doesn't have an option to show memberships of teams unless you are part of the organization. So, there's no good way to automatically make sure everything is visible publicly. That's what this was trying to say. I've updated it to be clearer.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sure ... however what does "kept via a GitHub Team" mean then?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

image

image

https://docs.github.com/en/organizations/organizing-members-into-teams/about-teams

Could you give me a suggestion on how to update the sentence to make it more clear?

Copy link
Contributor

Choose a reason for hiding this comment

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

GitHub doesn't have an option to show memberships of teams unless you are part of the organization. So, there's no good way to automatically make sure everything is visible publicly. That's what this was trying to say. I've updated it to be clearer.

If the Teams page is not accessible to everyone we shouldn't be using it as main reference IMHO.
We already have a maintainers file within the gem5 repo: https://github.com/gem5/gem5/blob/stable/MAINTAINERS.yaml.

Can't we add a similar file for the PMC?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think @giactra 's suggestion is the way I would go about it, but if it's not possible then I think the current wording is ok.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, we can do this. I suggest doing it when I move the governance into the repo. We can have a single PR that fixes the maintainers, PMC list, and moves the governance into the gem5 repo.

Would that be acceptable?

I will likely put PMC and MAINTAINERS in the same file.

Copy link
Contributor

Choose a reason for hiding this comment

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

If @giactra is ok with it, it's fine with me -- I will wait to approve until he confirms.

Copy link
Contributor

@mattsinc mattsinc left a comment

Choose a reason for hiding this comment

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

Just the one question about GitHub Team remains

@giactra
Copy link
Contributor

giactra commented Apr 28, 2025

Hi Jason, I haven't reviewed the document word for word, but it looks like a good improvement to me.

My overall feeling (no need to address it with this PR and maybe we should defer its discussion to a dev meeting) is that we should try to make the governance document as tool agnostic as we can, and push most of the low level technicalities to other existing documents. Is using GitHub (e.g. over GitLab) really relevant in terms of governance of the project?

For instance I feel most of the indications on how to contribute to the project could go (and probably are already there) to the CONTRIBUTING.md file. In this way

  1. We don't bloat the governance
  2. We also ensure the governance file changes only if a real governance change happens
  3. We avoid inconsistencies between CONTRIBUTING.md and GOVERNANCE.md

@powerjg
Copy link
Contributor Author

powerjg commented May 6, 2025

we should try to make the governance document as tool agnostic as we can

This is a good idea. I'll hold off on this until after this PR is merged.

@powerjg powerjg requested a review from mattsinc May 6, 2025 21:32
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.

3 participants