Skip to content

Commit

Permalink
Merge pull request #82 from aterrel/75-add-governance-docs
Browse files Browse the repository at this point in the history
Adds governance documents
aterrel authored Jan 26, 2025
2 parents 9c07416 + fc2117d commit 3b52ced
Showing 2 changed files with 49 additions and 1 deletion.
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# 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).

# Contibuting

- [Ways to Contribute](#ways-to-contribute)
@@ -12,6 +16,9 @@

The original body of work took place at a series of unconferences and various spurts of energy, today the DISCOVER-cookbook is a living project with numerous contributors. Because it is code to produce a book rather than code for a software library or application, it has different needs than typical open source software systems. Because of these unique needs, we separate various types of contributions:

All contributions should conform to the [NumFOCUS Contributor Code of Conduct](https://www.numfocus.org/about/code-of-conduct/).


## Ideas, Questions, and Discussions
Please contribute ideas, questions, and discussions for content or enhancements over in the discussions tab.

@@ -24,7 +31,7 @@ Please add issues on the github issue tracker.
While content is the heart of the project, the quality of the content needs to remain high. Due to a high volume of generated text being submitted for review, content takes longer to review and approve. We value these contributions but just understand that it will take time to add. Please start an idea in the discussions, then move to making an issue once there is approval for the content to be added to the book. After that issue is made we feel free to open a pull request against the repository to begin the review process.

## Bug fixes
For issues with other elements of the book, first make sure an issue is open and tracking can occur on the issue. Then open a a pull request](https://github.com/numfocus/DISCOVER-Cookbook/pulls).
For issues with other elements of the book, first make sure an [open an issue](https://github.com/numfocus/DISCOVER-handbook/issues) and tracking can occur on the issue. Then open a a pull request](https://github.com/numfocus/DISCOVER-Cookbook/pulls).

## See Also

41 changes: 41 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## 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 3b52ced

Please sign in to comment.