generated from ossf/project-template
-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add contributor guidance (OSPS-DO-02)
- Loading branch information
1 parent
1d065e8
commit 1e6b325
Showing
1 changed file
with
26 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |