Skip to content

Commit

Permalink
Adds governance documents
Browse files Browse the repository at this point in the history
- GOVERNANCE.md for addressing purpose, roles, responsibilities, and
  conflict resolution
- CONTRIBUTING.md for describing the appropriate contributions to the
  repository

See issue numfocus#75 for context
  • Loading branch information
aterrel committed Dec 26, 2024
1 parent fe62fb3 commit 5451880
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# DISCOVER Handbook Contribution Guide



NumFOCUS invites the community to make suggestions for improvements to the DISCOVER Cookbook via [pull request (PR)](https://github.com/numfocus/DISCOVER-handbook).

PRs will be evaluated by the NumFOCUS DISC Committee and/or its volunteers.

PRs should be written so as to conform to the [NumFOCUS Contributor Code of Conduct](https://www.numfocus.org/about/code-of-conduct/).

You can also [open an issue](https://github.com/numfocus/DISCOVER-handbook/issues) to suggest an update.

43 changes: 43 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## DISCOVER Handbook Governance Guide

The purpose of this document is to outline the purpose, roles, and decision processes for this repository. The hope is to guide the community on how to accept contributions and maintain the cookbook to the standards of the NumFOCUS Community. This document should not be taken as

# **Open Source Project � Objectives**

* Conference Organizer Enablement
- Conference organizers should be able to easily access and use the handbook
- Every effort will be made to be responsive to ISV issues
* Repo Quality
- Repo remains in healthy state with good-quality, consistent codebase
- Continuous Integration: Using Github Actions we are able to deploy the guide, preview pull-requests, and run quality checks on content.

# **Roles and Definitions**
* Contributor, Commenter, User
- Submitting contributions, creating issues, or using the contents of the repository
- Reviewing pull requests
* Maintainer
- Experienced project members who have made numerous contributions
- Write control: Approve pull/merge requests (verify submissions vs. acceptance criteria)
- Monitor github issues and drive timely resolution
- Ensure project information such as the Readme, Contributing docs, wiki, etc., kept up-to-date
* NumFOCUS DISC Committee
- Lead the project in terms of versioning, quality assurance, and overarching objectives
- Act as a facilitator in resolving technical and content conflicts
- Designate new approvers
* NumFOCUS Administration Board
- Approve member elections to DISC Committee
- Provide oversight for committee


# **Acceptance Criteria and Process**
- All source code and document copyrights will be owned by Contributer
- Submissions of source code and documents implies a perpetual MIT license to the DISCOVER community
- Contributions are via pull requests
- Maintainers will assign approvers to contributor pull requests
- Approvers can self-assign their reviewers
- For complex or invasive contributions, Maintainers may request approval from specific reviewers
- At least one review approval is required to complete a pull request
- The goal is to be responsive to contributors while ensuring acceptance criteria is met and to facilitate their submissions
- Approval is dependent upon adherence to the guidelines in [CONTRIBUTING.md](CONTRIBUTING.md), and alignment with
repository goals of maintainability, completeness, and quality
- Conflicts or questions will ultimately be resolved by the NumFOCUS DISC Committee

0 comments on commit 5451880

Please sign in to comment.