Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions COMMITTERS.csv

This file was deleted.

10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ For a description of the roles and responsibilities of the various members of th

If you just need help or have a question, refer to [SUPPORT.md](SUPPORT.md).

## Project committers

The current committers of the project are listed below. Committers review and approve contributions, and form the initial voting membership of the Technical Steering Committee as described in the [Technical Charter](tsc/charter.md). To request committer status, follow the process in [GOVERNANCE.md](GOVERNANCE.md#committer).

| Name | GitHub | Email |
| --- | --- | --- |
| Josh Bainbridge | [@joshbainbridge](https://github.com/joshbainbridge) | josh.bainbridge@gmail.com |
| Jose Esteve | [@joesfer](https://github.com/joesfer) | jose.esteve@framestore.com |
| Chris Haldane | [@chaldane](https://github.com/chaldane) | chris.haldane@framestore.com |

## How to contribute a bug fix or change

<!-- MKDOCS_SPLIT: contributing.md -->
Expand Down
22 changes: 16 additions & 6 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The committer role enables the contributor to commit code directly to the reposi
### Process for becoming a committer

* Show your experience with the codebase through contributions and engagement on the community channels.
* Request to become a committer. To do this, create a new pull request that adds your name and details to the COMMITTERS.csv file and request existing committers to approve.
* Request to become a committer. To do this, create a new pull request that adds your name and details to the [committers list](CONTRIBUTING.md#project-committers) and request existing committers to approve.
* After the majority of committers approve you, merge in the PR. Be sure to tag the whomever is managing the GitHub permissions to update the committers team in GitHub.

### Committer responsibilities
Expand All @@ -36,22 +36,32 @@ The committer role enables the contributor to commit code directly to the reposi

If a committer is no longer interested or cannot perform the committer duties listed above, they should volunteer to be moved to emeritus status. In extreme cases this can also occur by a vote of the committers per the voting process below.

## Lead
## Technical Steering Committee (TSC)

The project committers will elect a lead (and optionally a co-lead) which will be the primary point of contact for the project and representative to the TAC upon becoming an Active stage project. The lead(s) will be responsible for the overall project health and direction, coordination of activities, and working with other projects and committees as needed for the continued growth of the project.
The Technical Steering Committee (TSC) is responsible for all technical oversight of the project. The full responsibilities and procedures of the TSC are defined in the project's [Technical Charter](tsc/charter.md), which is the binding governing document for the project.

The current TSC members are:

* Josh Bainbridge (Chair)
* Lorna Dumba
* Nathan Walster
* Mark Hills

### TSC Chair

The TSC may elect a TSC Chair (and optionally a co-chair) who will be the primary point of contact for the project and its representative to the Academy Software Foundation's Technical Advisory Council (TAC). The TSC Chair is responsible for the overall project health and direction, coordination of activities, presiding over TSC meetings, and working with other projects and committees as needed for the continued growth of the project.

# Release process

Project releases will occur on a scheduled basis as agreed to by the committers.

# Conflict resolution and voting

In general, we prefer that technical issues and committer membership are amicably worked out between the persons involved. If a dispute cannot be decided independently, the committers can be called in to decide an issue. If the committers themselves cannot decide an issue, the issue will be resolved by voting. The voting process is a simple majority in which each committer receives one vote.
In general, we prefer that technical issues and committer membership are amicably worked out between the persons involved. If a dispute cannot be decided independently, the TSC can be called in to decide an issue. If the TSC itself cannot decide an issue, the issue will be resolved by voting. The voting process is a simple majority in which each TSC voting member receives one vote, as described in the [Technical Charter](tsc/charter.md).

# Communication

This project, just like all of open source, is a global community. In addition
to the [Code of Conduct](CODE_OF_CONDUCT.md), this project will:
This project, just like all of open source, is a global community. In addition to the [Code of Conduct](CODE_OF_CONDUCT.md), this project will:

* Keep all communication on open channels (mailing list, forums, chat).
* Be respectful of time and language differences between community members (such as scheduling meetings, email/issue responsiveness, etc).
Expand Down
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1150,7 +1150,7 @@ The directories are:
- `scripts`: Utility scripts for command line and CI usage.
- `src/tests`: Unit and statistical hypothesis testing.
- `src/tools`: Project tooling for analysis and offline optimisation.
- `tsc`: Meeting notes and project process documentation.
- `tsc`: Project charter and process documentation.

### Dependencies

Expand Down Expand Up @@ -1437,6 +1437,17 @@ OpenQMC doesn't solve your problem, one of these might be a better option:
- [Pbrt](https://github.com/mmp/pbrt-v4) is a seminal resource on all things
rendering, but is written for educational purposes.

## Leadership

OpenQMC is an Academy Software Foundation project, governed by a Technical
Steering Committee (TSC). The leadership roster, project roles, and decision
making process are described in [GOVERNANCE.md](GOVERNANCE.md), with the binding
details set out in the project's [Technical Charter](tsc/charter.md).

TSC meetings are open to the community. Meeting notes, minutes and the schedule
are maintained on the project's Confluence space: [OpenQMC on
Confluence](https://lf-aswf.atlassian.net/wiki/spaces/OpenQMC/overview).

## Contributing

All contributions to the project are welcome. For guidance on how to contribute
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This file describes the project security policy.

## Reporting a Vulnerability

If you think you've found a potential vulnerability in OpenQMC, please report it by emailing josh.bainbridge@gmail.com. Only Technical Steering Committee members and Academy Software Foundation project management have access to these messages. Include detailed steps to reproduce the issue, and any other information that could aid an investigation. Our policy is to respond to vulnerability reports within 14 days, address critical security vulnerabilities rapidly and post patches as quickly as possible.
If you think you've found a potential vulnerability in OpenQMC, please report it by emailing openqmc-tsc-private@lists.aswf.io. Only Technical Steering Committee members and Academy Software Foundation project management have access to these messages. Include detailed steps to reproduce the issue, and any other information that could aid an investigation. Our policy is to respond to vulnerability reports within 14 days, address critical security vulnerabilities rapidly and post patches as quickly as possible.

## Known Vulnerabilities

Expand Down
2 changes: 1 addition & 1 deletion SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ OpenQMC manages bug and enhancement using its [issue](https://github.com/Academy

## How to report a security vulnerability

If you think you've found a potential vulnerability in OpenQMC, please email josh.bainbridge@gmail.com to responsibly disclose it.
If you think you've found a potential vulnerability in OpenQMC, please email openqmc-tsc-private@lists.aswf.io to responsibly disclose it.

## Contributing a fix

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ nav:
- Increasing Sampling Rate: splitting.md
- Releases: releases.md
- Go to API Reference: https://academysoftwarefoundation.github.io/openqmc/api-reference
- Go to Confluence: https://lf-aswf.atlassian.net/wiki/spaces/OpenQMC/overview
theme:
name: material
custom_dir: mkdocs
Expand Down
40 changes: 0 additions & 40 deletions tsc/meetings/2023-06-06.md

This file was deleted.

26 changes: 0 additions & 26 deletions tsc/meetings/kickoff_meeting_agenda.md

This file was deleted.

28 changes: 0 additions & 28 deletions tsc/meetings/yyyy-mm-dd.md

This file was deleted.

5 changes: 2 additions & 3 deletions tsc/process/codereview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,15 @@ The Technical Steering Committee have write-access to the OpenQMC repository and
* No direct commits to the main (or any other protected) branch, every code change should be a pull request
* Any member of the community can provide feedback on any pull request (and is encouraged to do so)
* A CODEOWNERS file introduced to the root of the repo to configure ownership (global, per-directory and/or per-file) - this will automatically request pull request reviews from the relevant maintainers (https://help.github.com/articles/about-codeowners/)
* Minimum of one non-author TSC member approval on every pull request before merging
* Minimum of one TSC member or committer approval on every pull request before merging
* Non fast-forward merges must be used (ie the merge must not be rebased onto main)
* Azure Pipelines CI and DCO status checks must strictly pass before merging, other (TBD) checks should loosely pass (https://help.github.com/articles/types-of-required-status-checks)
* CI and DCO status checks must strictly pass before merging (https://help.github.com/articles/types-of-required-status-checks)

## Best Practices

* Prefer all requested reviewers to approve before merging
* Merging a pull request should be the responsibility of the author if they are a TSC member
* Any TSC member can merge a pull request authored by a non-TSC member, but with a preferred minimum of two approvals from TSC members (including themself)
* Re-writing the branch history by rebasing a pull request branch just before a merge is discouraged, unless it significantly improves the overall history (such as any broken commits on the review branch that might make reverting or bisecting more difficult)
* Prefer pull requests to be open for a minimum of 72 hours before merging in order to gather any feedback
* Aim for all pull requests to be responded to by one of the TSC members within a minimum of two weeks with either explanation of non-acceptance, request for changes or merge
* TSC meetings should regularly review and discuss any outstanding pull requests
Expand Down
13 changes: 0 additions & 13 deletions tsc/process/deprecation.md

This file was deleted.

20 changes: 0 additions & 20 deletions tsc/process/release.md

This file was deleted.

35 changes: 0 additions & 35 deletions tsc/process/security.md

This file was deleted.

Loading
Loading