Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (29 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.52 KB
Raw

Contributing to the Security Baseline

Contributing to the Controls:

Currently, all the baseline controls are in baseline.yaml; follow the structure in the README 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). In addition to a clear title and descriptive commit message, PRs MUST meet the following criteria:

Check Go Tooling Linter

The OSPS Baseline tools are written in Go and the repository enforces linting on every pull request. Before opening a PR, you can test your changes make the linter happy by running golangci-lint locally in the cmd/ directory:

cd cmd/
golangci-lint run

CSpell Check and Dictionary

The repo will enforce spell checks across the codebase. If you introduce new words that the spell checker does not recognize, just add them to the .cspell.yaml file.

Maintainer Status

See ./governance/GOVERNANCE.md for the process of achieving maintainer status on the project.