docs: add definition and voting rules of `-contrib` repositories #707

ingomueller-net · 2024-09-13T13:30:14Z

This PR adds the concept of -contrib repositories to the governance rules of Substrait. To that aim, the following changes are made:

Mention that there is a distinction between "core" and -contrib repositories in the introduction of the Substrait project. Those definitions are used in what follows.
Say that contributors can be given write access to -contrib repositories by the SMC. This allows people to make changes to those repositories without being promoted to committers.
Clarify that committers are people who have write access to all repositories, i.e., "core" and -contrib repositories. This makes clear that having write access to a -contrib repository doesn't make someone a committer.
Add a voting rule for -contrib repositories:
- The SMC needs to vote to create new -contrib repos and to give write access to them.
- Any contributor other than the proposer can vote. This is a pretty low bar but it ensures that one other human being with some relationship to the project approves the change.

github-actions · 2024-09-13T13:30:43Z

ACTION NEEDED

Substrait follows the Conventional Commits
specification for
release automation.

The PR title and description are used as the merge commit message. Please update your PR title and description to match the specification.

jpienaar

(sending comments corresponding to some offline clarification questions asked)

jpienaar · 2024-09-13T17:38:02Z

site/docs/governance.md


 ### Committer

-A committer is a developer who has write access to the code repositories and has a signed [Contributor License Agreement (CLA)](https://cla-assistant.io/substrait-io/substrait) on file. Not needing to depend on other people to make patches to the code or documentation, they are actually making short-term decisions for the project. The SMC can (even tacitly) agree and approve the changes into permanency, or they can reject them. Remember that the SMC makes the decisions, not the individual committers.
+A committer is a developer who has write access to the core (i.e., non `-contrib`) repositories and has a signed [Contributor License Agreement (CLA)](https://cla-assistant.io/substrait-io/substrait) on file. Not needing to depend on other people to make patches to the code or documentation, they are actually making short-term decisions for the project. The SMC can (even tacitly) agree and approve the changes into permanency, or they can reject them. Remember that the SMC makes the decisions, not the individual committers.


Would a committer by default also have write access to contrib repos?

I think the answer is yes. This should be clarified.

yes, agreed. committers and smc should have same or greater rights in -contrib.

Addressed in latest commit.

jpienaar · 2024-09-13T17:38:39Z

site/docs/governance.md

@@ -27,11 +27,11 @@ A user is someone who uses Substrait. They may contribute to Substrait by provid

 ### Contributors

-A contributor is a user who contributes to the project in the form of code or documentation. They take extra steps to participate in the project (loosely defined as the set of repositories under the github substrait-io organization) , are active on the developer mailing list, participate in discussions, and provide patches, documentation, suggestions, and criticism.
+A contributor is a user who contributes to the project in the form of code or documentation. They take extra steps to participate in the project (loosely defined as the set of repositories under the github substrait-io organization), are active on the developer mailing list, participate in discussions, and provide patches, documentation, suggestions, and criticism. Contributers may be given write access to `-contrib` repositories.


Would write access would also require signing CLA?

I think the answer is yes. This should be clarified.

Suggested change

A contributor is a user who contributes to the project in the form of code or documentation. They take extra steps to participate in the project (loosely defined as the set of repositories under the github substrait-io organization), are active on the developer mailing list, participate in discussions, and provide patches, documentation, suggestions, and criticism. Contributers may be given write access to `-contrib` repositories.

Contributers may be given write access to `-contrib` repositories.

Suggested change

A contributor is a user who contributes to the project in the form of code or documentation. They take extra steps to participate in the project (loosely defined as the set of repositories under the github substrait-io organization), are active on the developer mailing list, participate in discussions, and provide patches, documentation, suggestions, and criticism. Contributers may be given write access to `-contrib` repositories.

Contributors are given write access to specific `-contrib` repositories by an SMC consensus vote per repository. The vote should be open for a week to allow adequate time for other SMC members to voice any concerns prior to providing write access.

Applied in latest commit.

ingomueller-net · 2024-09-13T19:13:58Z

(sending comments corresponding to some offline clarification questions asked)

Thanks, @jpienaar! Let me add another question that we may or may not want to address in the guidelines: How does one get the Github permissions to submit a contrib proeject.

westonpace · 2024-09-13T21:47:13Z

Any contributor other than the proposer can vote. This is a pretty low bar but it ensures that one other human being with some relationship to the project approves the change.

I think that's fine, and a good minimum to have.

I guess my question is really still, for a particular contrib project X, who has write access to it? In particular, because we don't yet have a "contributor role" in github it is somewhat under defined as "anyone who has submitted code before can call themselves a contributor".

Here's a few examples we could take (feel free to propose more):

Approach A: Committers (or maybe just the SMC) can give any contributor (really just "github account" in this case) write access to a contrib project as a judgement call (based on discussion with other contributors in the project, past history of positive open source interaction, etc.). This is a more narrow, selective approach that requires a little bit more up-front work to get access to a contrib project.

Approach B: We create a Github role for contributors. Anyone may ask to have the role and SMC should hand it out freely. As long as they have it they can be given write access to all contrib repos. This is a much broader approach and could potentially let in bad actors. We could make sure to put in rules like "no force push, etc." so that hopefully any malicious behavior is reversible.

Approach C: Every contrib project has an owner, determined by the committer/SMC that creates the contrib project. That owner has not just write access but also admin access to the repo and can grant others write / admin privileges to the repo as well (need to confirm this kind of role is possible in Github). This is more individualized, letting each contrib project owner have a lot more control over who can access the project.

ingomueller-net · 2024-09-16T08:18:58Z

I guess my question is really still, for a particular contrib project X, who has write access to it? In particular, because we don't yet have a "contributor role" in github it is somewhat under defined as "anyone who has submitted code before can call themselves a contributor".

Here's a few examples we could take (feel free to propose more):
[...]

Yeah, this question needs clarification. I think all of the three proposals are valid. I don't think we should tailer this too the concrete case of the MLIR dialect, though, so my opinion is only one of many to consider.

Independent of these options, I do get the feeling that there is a certain hierarchy within a -contrib project, maybe regular contributors and "contrib committers", which are those with write and review privileges.

I wait a bit more to give others the time to chime in and propose formulation based on that...

EpsilonPrime · 2024-09-16T08:39:06Z

Do we want to clarify admin rights as well? Presumably the ability to transfer the project would remain under the control of SMC members but is there some amount of control that we want to cede to allow for project management? I lean towards keeping all of the projects the same in this regard.

jacques-n · 2024-09-19T01:25:41Z

site/docs/governance.md


 ### Committer

-A committer is a developer who has write access to the code repositories and has a signed [Contributor License Agreement (CLA)](https://cla-assistant.io/substrait-io/substrait) on file. Not needing to depend on other people to make patches to the code or documentation, they are actually making short-term decisions for the project. The SMC can (even tacitly) agree and approve the changes into permanency, or they can reject them. Remember that the SMC makes the decisions, not the individual committers.
+A committer is a developer who has write access to the core (i.e., non `-contrib`) repositories and has a signed [Contributor License Agreement (CLA)](https://cla-assistant.io/substrait-io/substrait) on file. Not needing to depend on other people to make patches to the code or documentation, they are actually making short-term decisions for the project. The SMC can (even tacitly) agree and approve the changes into permanency, or they can reject them. Remember that the SMC makes the decisions, not the individual committers.


yes, agreed. committers and smc should have same or greater rights in -contrib.

jacques-n · 2024-09-19T01:27:09Z

site/docs/governance.md

@@ -64,6 +64,7 @@ The rules require that a community member registering a negative vote must inclu
 | Non-breaking function introductions                                                                       | 1 (not including proposer) | Committers     | Github PR       |
 | Non-breaking extension additions & non-format code modifications                                          | 1 (not including proposer) | Committers     | Github PR       |
 | Changes (non-breaking or breaking) to a Substrait *library* (i.e. substrait-java, substrait-validator)    | 1 (not including proposer) | Committers     | Github PR       |
+| Changes to a Substrait `-contrib` repository                                                              | 1 (not including proposer) | Contributers   | Github PR       |


Here and above... should be "Contributors" not "Contributers"

Fixed in latest commit -- thanks!

jacques-n · 2024-09-19T01:30:58Z

site/docs/governance.md

@@ -27,11 +27,11 @@ A user is someone who uses Substrait. They may contribute to Substrait by provid

 ### Contributors

-A contributor is a user who contributes to the project in the form of code or documentation. They take extra steps to participate in the project (loosely defined as the set of repositories under the github substrait-io organization) , are active on the developer mailing list, participate in discussions, and provide patches, documentation, suggestions, and criticism.
+A contributor is a user who contributes to the project in the form of code or documentation. They take extra steps to participate in the project (loosely defined as the set of repositories under the github substrait-io organization), are active on the developer mailing list, participate in discussions, and provide patches, documentation, suggestions, and criticism. Contributers may be given write access to `-contrib` repositories.


Suggested change

A contributor is a user who contributes to the project in the form of code or documentation. They take extra steps to participate in the project (loosely defined as the set of repositories under the github substrait-io organization), are active on the developer mailing list, participate in discussions, and provide patches, documentation, suggestions, and criticism. Contributers may be given write access to `-contrib` repositories.

Contributers may be given write access to `-contrib` repositories.

Suggested change

A contributor is a user who contributes to the project in the form of code or documentation. They take extra steps to participate in the project (loosely defined as the set of repositories under the github substrait-io organization), are active on the developer mailing list, participate in discussions, and provide patches, documentation, suggestions, and criticism. Contributers may be given write access to `-contrib` repositories.

Contributors are given write access to specific `-contrib` repositories by an SMC consensus vote per repository. The vote should be open for a week to allow adequate time for other SMC members to voice any concerns prior to providing write access.

jacques-n · 2024-09-19T01:31:17Z

site/docs/governance.md

@@ -64,6 +64,7 @@ The rules require that a community member registering a negative vote must inclu
 | Non-breaking function introductions                                                                       | 1 (not including proposer) | Committers     | Github PR       |
 | Non-breaking extension additions & non-format code modifications                                          | 1 (not including proposer) | Committers     | Github PR       |
 | Changes (non-breaking or breaking) to a Substrait *library* (i.e. substrait-java, substrait-validator)    | 1 (not including proposer) | Committers     | Github PR       |
+| Changes to a Substrait `-contrib` repository                                                              | 1 (not including proposer) | Contributers   | Github PR       |


Let's add an additional line for adding a contributor to a -contrib repo.

Done in latest commit.

ingomueller-net

Those a good suggestions -- thanks @jacques-n! All applied/addressed/fixed in the latest commit.

ingomueller-net · 2024-09-24T08:07:57Z

site/docs/governance.md

@@ -27,11 +27,11 @@ A user is someone who uses Substrait. They may contribute to Substrait by provid

 ### Contributors

-A contributor is a user who contributes to the project in the form of code or documentation. They take extra steps to participate in the project (loosely defined as the set of repositories under the github substrait-io organization) , are active on the developer mailing list, participate in discussions, and provide patches, documentation, suggestions, and criticism.
+A contributor is a user who contributes to the project in the form of code or documentation. They take extra steps to participate in the project (loosely defined as the set of repositories under the github substrait-io organization), are active on the developer mailing list, participate in discussions, and provide patches, documentation, suggestions, and criticism. Contributers may be given write access to `-contrib` repositories.


Applied in latest commit.

ingomueller-net · 2024-09-24T08:08:11Z

site/docs/governance.md


 ### Committer

-A committer is a developer who has write access to the code repositories and has a signed [Contributor License Agreement (CLA)](https://cla-assistant.io/substrait-io/substrait) on file. Not needing to depend on other people to make patches to the code or documentation, they are actually making short-term decisions for the project. The SMC can (even tacitly) agree and approve the changes into permanency, or they can reject them. Remember that the SMC makes the decisions, not the individual committers.
+A committer is a developer who has write access to the core (i.e., non `-contrib`) repositories and has a signed [Contributor License Agreement (CLA)](https://cla-assistant.io/substrait-io/substrait) on file. Not needing to depend on other people to make patches to the code or documentation, they are actually making short-term decisions for the project. The SMC can (even tacitly) agree and approve the changes into permanency, or they can reject them. Remember that the SMC makes the decisions, not the individual committers.


Addressed in latest commit.

ingomueller-net · 2024-09-24T08:08:23Z

site/docs/governance.md

@@ -64,6 +64,7 @@ The rules require that a community member registering a negative vote must inclu
 | Non-breaking function introductions                                                                       | 1 (not including proposer) | Committers     | Github PR       |
 | Non-breaking extension additions & non-format code modifications                                          | 1 (not including proposer) | Committers     | Github PR       |
 | Changes (non-breaking or breaking) to a Substrait *library* (i.e. substrait-java, substrait-validator)    | 1 (not including proposer) | Committers     | Github PR       |
+| Changes to a Substrait `-contrib` repository                                                              | 1 (not including proposer) | Contributers   | Github PR       |


Fixed in latest commit -- thanks!

ingomueller-net · 2024-09-24T08:08:35Z

site/docs/governance.md

@@ -64,6 +64,7 @@ The rules require that a community member registering a negative vote must inclu
 | Non-breaking function introductions                                                                       | 1 (not including proposer) | Committers     | Github PR       |
 | Non-breaking extension additions & non-format code modifications                                          | 1 (not including proposer) | Committers     | Github PR       |
 | Changes (non-breaking or breaking) to a Substrait *library* (i.e. substrait-java, substrait-validator)    | 1 (not including proposer) | Committers     | Github PR       |
+| Changes to a Substrait `-contrib` repository                                                              | 1 (not including proposer) | Contributers   | Github PR       |


Done in latest commit.

ingomueller-net · 2024-09-24T08:14:34Z

I have just pushed a new commit and updated the commit message. I hope it addresses all issues raised until now.

@westonpace said:

I guess my question is really still, for a particular contrib project X, who has write access to it? In particular, because we don't yet have a "contributor role" in github it is somewhat under defined as "anyone who has submitted code before can call themselves a contributor".

The current version says that the SMC creates repos and gives write access. After that, anyone who declares themselves as a contributor can +1 a change from someone with write access, who can then merge it. That bar is still low but I haven't heard explicit opposition to that.

@EpsilonPrime said:

Do we want to clarify admin rights as well? Presumably the ability to transfer the project would remain under the control of SMC members but is there some amount of control that we want to cede to allow for project management? I lean towards keeping all of the projects the same in this regard.

I agree. I think that the latest commit (essentially proposed by @jacques-n) lets the SMC keep control on project management and minimizes the differences between the two kind of repos, except that some contributors can be given write access to the -contrib repos.

Let me know what you think.

This PR adds the concept of `-contrib` repositories to the governance rules of Substrait. To that aim, the following changes are made: * Mention that there is a distinction between "core" and `-contrib` repositories in the introduction of the Substrait project. Those definitions are used in what follows. * Say that contributors can have write access to `-contrib` repositories. This allows people to make changes to those repositories without being promoted to committers. * Clarify that committers are people who have write access to "core" repositories. This makes clear that having write access to a `-contrib` repository doesn't make someone a committer. * Add a voting rule for `-contrib` repositories: Any contributor other than the proposer can vote. This is a pretty low bar but it ensures that one other human being with some relationship to the project approves the change. Signed-off-by: Ingo Müller <[email protected]>

@jacques-n

* Apply @jacques-n's suggestion on how to give write access to `-contrib` repositories. * Apply @jacques-n's suggestion on committer rights in `-contrib` repositories. * Apply @jacques-n's suggestion on voting rules related to `-contrib` repositories. * Fix typo in "contributor."

site/docs/governance.md

Co-authored-by: Weston Pace <[email protected]>

vbarua

Associated email vote: https://groups.google.com/g/substrait/c/vtznmLDowTw

jacques-n · 2024-10-03T02:30:25Z

Given the succesful vote, merging.

ingomueller-net · 2024-10-09T12:32:01Z

Awesome! Thank you all for the support in this process!

ingomueller-net requested review from jacques-n, cpcloud, westonpace, EpsilonPrime and vbarua as code owners September 13, 2024 13:30

ingomueller-net force-pushed the contrib-repositories branch from 51610ac to eb307a7 Compare September 13, 2024 13:31

ingomueller-net changed the title ~~docs: Add definition and voting rules of -contrib repositories~~ docs: add definition and voting rules of -contrib repositories Sep 13, 2024

jpienaar reviewed Sep 13, 2024

View reviewed changes

jacques-n reviewed Sep 19, 2024

View reviewed changes

ingomueller-net commented Sep 24, 2024

View reviewed changes

ingomueller-net added 3 commits September 24, 2024 08:14

Fix unrelated white space error.

c6f345c

ingomueller-net force-pushed the contrib-repositories branch from 4e5f05c to a41b3c1 Compare September 24, 2024 08:14

westonpace previously approved these changes Sep 26, 2024

View reviewed changes

westonpace reviewed Sep 26, 2024

View reviewed changes

site/docs/governance.md Outdated Show resolved Hide resolved

mbrobbel previously approved these changes Sep 26, 2024

View reviewed changes

vbarua previously approved these changes Sep 26, 2024

View reviewed changes

jacques-n previously approved these changes Sep 27, 2024

View reviewed changes

jacques-n dismissed stale reviews from vbarua, mbrobbel, westonpace, and themself via 1f5e092 September 27, 2024 02:07

Update site/docs/governance.md

1f5e092

Co-authored-by: Weston Pace <[email protected]>

vbarua approved these changes Sep 27, 2024

View reviewed changes

jacques-n merged commit 774c7db into substrait-io:main Oct 3, 2024
13 checks passed

ingomueller-net deleted the contrib-repositories branch October 9, 2024 12:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add definition and voting rules of `-contrib` repositories #707

docs: add definition and voting rules of `-contrib` repositories #707

ingomueller-net commented Sep 13, 2024 •

edited

Loading

github-actions bot commented Sep 13, 2024

jpienaar left a comment

jpienaar Sep 13, 2024

ingomueller-net Sep 13, 2024

jacques-n Sep 19, 2024

ingomueller-net Sep 24, 2024

jpienaar Sep 13, 2024

ingomueller-net Sep 13, 2024

jacques-n Sep 19, 2024

ingomueller-net Sep 24, 2024

ingomueller-net commented Sep 13, 2024

westonpace commented Sep 13, 2024 •

edited

Loading

ingomueller-net commented Sep 16, 2024

EpsilonPrime commented Sep 16, 2024

jacques-n Sep 19, 2024

jacques-n Sep 19, 2024

ingomueller-net Sep 24, 2024

jacques-n Sep 19, 2024

jacques-n Sep 19, 2024

ingomueller-net Sep 24, 2024

ingomueller-net left a comment

ingomueller-net Sep 24, 2024

ingomueller-net Sep 24, 2024

ingomueller-net Sep 24, 2024

ingomueller-net Sep 24, 2024

ingomueller-net commented Sep 24, 2024

vbarua left a comment

jacques-n commented Oct 3, 2024

ingomueller-net commented Oct 9, 2024

docs: add definition and voting rules of -contrib repositories #707

docs: add definition and voting rules of -contrib repositories #707

Conversation

ingomueller-net commented Sep 13, 2024 • edited Loading

github-actions bot commented Sep 13, 2024

jpienaar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ingomueller-net commented Sep 13, 2024

westonpace commented Sep 13, 2024 • edited Loading

ingomueller-net commented Sep 16, 2024

EpsilonPrime commented Sep 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ingomueller-net left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ingomueller-net commented Sep 24, 2024

vbarua left a comment

Choose a reason for hiding this comment

jacques-n commented Oct 3, 2024

ingomueller-net commented Oct 9, 2024

docs: add definition and voting rules of `-contrib` repositories #707

docs: add definition and voting rules of `-contrib` repositories #707

ingomueller-net commented Sep 13, 2024 •

edited

Loading

westonpace commented Sep 13, 2024 •

edited

Loading