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

Contribution guide #29

Open
ryanmwhitephd opened this issue Jun 26, 2023 · 5 comments
Open

Contribution guide #29

ryanmwhitephd opened this issue Jun 26, 2023 · 5 comments
Assignees

Comments

@ryanmwhitephd
Copy link
Contributor

Contribution guide for measurement domain experts. The guide is currently included in the README as well as in docs/contributing.rst. See branch contrib_guide.

@ryanmwhitephd
Copy link
Contributor Author

Contribution guide should also include the process for reviewing and approving issues and pull requests. Pull requests can have rules applied before a merge into main can occur.
Main branch protection rules:

  • Require pull request before merging
  • Require at least 1 approval before merging

@ryanmwhitephd
Copy link
Contributor Author

A number of approvals can be added. To add specific persons for approval (which we should), we'll need to setup a Team. With a Team, the governance would be reflected clearly in the GitHub team and approval process. GitHub Teams may have a fee. Here is a guide:
Here's a guide:

Teams:
    Ensure that you have teams created on your GitHub organization that represent contributing teams and approving teams.

Branch Protection:
    Go to your repository on GitHub.
    Navigate to "Settings" > "Branches."
    Add a branch protection rule for the branch you want to protect (e.g., master).
    Enable "Require pull request reviews before merging."

Reviewers:
    Under "Require review from Code Owners," specify the team(s) that should be responsible for code reviews.
    Add other teams or individuals who should also review the code.

Required Reviewers:
    Enable "Dismiss stale pull request approvals when new commits are pushed."
    Set the "Required approving review" to 3 (or the number you prefer).

@ryanmwhitephd
Copy link
Contributor Author

Information about Teams. We should setup a Team to create roles that can be used to manage the review process. Here is the guide:
https://docs.github.com/en/organizations/organizing-members-into-teams

@MarkKuster
Copy link
Contributor

Thanks, Ryan. I read the material and the idea looks very helpful. I suppose the team structure would effectively become our WG structure under the MII&AC.

@ryanmwhitephd
Copy link
Contributor Author

In addition to setting up Teams under the Organization, we also need to codeowners.

In order to setup reviews by codeowners in the pull request process, we need

The Teams @SchwartzMichael we want committers and coordinators to also be committee members, and at least one committer approves a PR and/or @MarkKuster approves a pull request.

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

When branches are created from issues, their pull requests are automatically linked.

2 participants