diff --git a/README.md b/README.md index 5292b27..901eecd 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,20 @@ -# Minimum Viable Governance + -## What is Minimum Viable Governance? +# Physiopy Governance -Minimum Viable Governance (MVG) - currently in beta - is a repository-based approach for putting lightweight governance into free and open source projects that are run in version control systems. It provides an overall two-tier organizational governance structure for a set of free and open source projects. At the top level (called an "organization" on GitHub), there is a technical steering committee to make decisions about the overall direction and coordination between all the organization's projects. Underneath that top level are the individual projects, with lightweight, consensus-based governance. +Physiopy's governance documents are based on GitHub's Minimum Viable Governance (MVP), which you can read more about here https://github.com/github/MVG. In brief, MVP is -There are two folders. The first, org-docs, provides top-level organizational governance and policies for a technical steering committee (TSC). The second folder, project-docs, provides a template for individual project governance, subject to the policies and oversight of the larger organization. +> "... a repository-based approach for putting lightweight governance into free and open source projects that are run in version control systems." -Minimum Viable Governance is meant as a way to quickly stand up collaborations that can grow with your organization and projects. If your organization grows to the point where a corporate home becomes necessary, typically when your organization begins holding money, MVG is designed to make that transition easy. +It is a two-tier structure with [organizational governance](org-docs) and [project governance](project-docs), explained below. -## Why would we want to use this? +## Organizational governance -Minimum Viable Governance allows you to start an organization and sub-projects with simple governance in place at the outset - including legal terms, licensing and trademark issues, and due process. Having this governance in place early helps avoid disputes among participants down the road. +At the organizational level, we have [steering committee members](org-docs/STEERING-COMMITTEE.md) and [advisory council members](org-docs/ADVISORY-COUNCIL.md). The roles of the steering committee and the advisory council are explained in the organization's [Charter](org-docs/CHARTER.md). This [Charter](org-docs/CHARTER.md) covers the organization mission, bodies (steering committee, advisory council, community members), decision making process, violations of governance terms, trademarks, confidentiality, project criteria, and contribution recognition/authorship. At the organizational level we also have the: +- [Code of conduct](org-docs/CODE-OF-CONDUCT.md) +- [GitHub Roles and Permissions for Physiopy](org-docs/PERMISSIONS.md) +- [Trademarks](org-docs/TRADEMARKS.md) -## How do we use this? +## Project governance -1. Review the documents and determine if this is right for you. -2. Describe the organization's mission in Section 1 of the [CHARTER.md](org-docs/CHARTER.md) file. -3. Put the org-docs in a repository for the organization's governance and have each initial TSC member "sign" the [STEERING-COMMITTEE.md](org-docs/STEERING-COMMITTEE.md) file by adding their name and organizational affiliation (if applicable) to the file. -4. For each project that will be under your organization's governance, create a repository under the organization and have each initial maintainer "sign" the [MAINTAINERS.md](project-docs/MAINTAINERS.md) file by adding their name and affiliation (if applicable) to the file. -5. [Choose a license](https://choosealicense.com/) or fill out the copyright information in the MIT [LICENSE.md](project-docs/LICENSE.md) file for each project. -6. Get to work. - -## Contributing - -Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. - -Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE). - -Please note that this project is released with a [Contributor Code of Conduct](https://raw.githubusercontent.com/EthicalSource/contributor_covenant/release/content/version/2/0/code_of_conduct.md) (CoC). By participating in this project you agree to abide by its terms. Violations of the CoC should be reported to: opensource@github.com. To avoid confusion with MVG artifacts, we did not place the CoC in the repo. - -### Submitting a pull request - -1. [Fork](https://github.com/github/MVG/fork) and clone the repository -2. Create a new branch: `git checkout -b my-branch-name` -3. Make your change -4. Push to your fork and [submit a pull request](https://github.com/github/MVG/compare) -5. Pat yourself on the back and wait for your pull request to be reviewed and merged. + The folder [project-docs](project-docs) provides a template for individual project governance, subject to the policies and oversight of the larger organization. The MVG suggests to use these as templates for each Physiopy 'project' (probably a repository, but could be a collection of repositories). **This project governance implementation is a work in progress.** diff --git a/org-docs/PERMISSIONS.md b/org-docs/PERMISSIONS.md index 09e6c88..1d67b84 100644 --- a/org-docs/PERMISSIONS.md +++ b/org-docs/PERMISSIONS.md @@ -8,7 +8,7 @@ We are aiming for a simple approach to begin with. Please reflect before adding The below rules should be implemented via the 'Role assignment' option on the organization settings page. Add a [team of users](https://github.com/orgs/physiopy/teams), or an individual user, to a specific role. -Image showing GitHub page where you set the role assignments +Image showing GitHub page where you set the role assignments ### Organization Owners or Maintainers @@ -28,7 +28,7 @@ The below rules should be implemented via the 'Role assignment' option on the or The below rules should be implemented via the 'Collaborators and teams' option on the repository settings page. Add a [team of users](https://github.com/orgs/physiopy/teams), or an individual user, to a specific role. -Image showing GitHub page where you set the role assignments +Image showing GitHub page where you set the role assignments **Must** - Each Physiopy repository should have a user assigned to Maintain it (this user should have **Maintainer** privileges, or above, on this repository) diff --git "a/pictures/phys2bids_logo2_1280\303\227640.png" "b/pictures/phys2bids_logo2_1280\303\227640.png" new file mode 100644 index 0000000..d92cb13 Binary files /dev/null and "b/pictures/phys2bids_logo2_1280\303\227640.png" differ diff --git a/org-docs/pictures/role_assignment.png b/pictures/role_assignment.png similarity index 100% rename from org-docs/pictures/role_assignment.png rename to pictures/role_assignment.png diff --git a/org-docs/pictures/role_assignment_repo.png b/pictures/role_assignment_repo.png similarity index 100% rename from org-docs/pictures/role_assignment_repo.png rename to pictures/role_assignment_repo.png