From 1e6b325343ee1fa24ceae1aac98c17c6068d8482 Mon Sep 17 00:00:00 2001 From: Evan Anderson Date: Thu, 19 Dec 2024 12:33:05 -0800 Subject: [PATCH] Add contributor guidance (OSPS-DO-02) --- CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ff1b470 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# Contributing to the Security Baseline + +## Contributing to the Criteria: + +Currently, all the baseline criteria are in `baseline.yaml`; follow the structure +[in the README](./README.md#baseline-structure) when proposing new entries. + +## Contributing to the Tooling: + +The baseline is published to https://baseline.openssf.org/ (via GitHub Pages) via +Jekyll (a static site generator) using scripts from `./cmd` and formatting from +`./docs`, using GitHub Actions. + +## PR guidelines + +All changes to the repository should be made via PR +([OSPS-AC-03](https://baseline.openssf.org/#osps-ac-03)). In addition to a clear +title and descriptive commit message, PRs MUST meet the following criteria: + +* DCO signoff (via `git commit -s` -- [OSPS-LE-01](https://baseline.openssf.org/#osps-le-01)) +* All checks must pass ([OSPS-QA-04](https://baseline.openssf.org/#osps-qa-04)) + +## Maintainer Status + +See [./governance/GOVERNANCE.md](./governance/GOVERNANCE.md#maintainer-status) for +the process of achieving maintainer status on the project. \ No newline at end of file