diff --git a/SECURITY.md b/.github/SECURITY.md similarity index 100% rename from SECURITY.md rename to .github/SECURITY.md diff --git a/README.md b/README.md index 3ccd0cb..a65492c 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The data tracked within this specification is intended to fill the gaps between Projects should include a `security-insights.yml` file in the root of their repository, or in the appropriate source forge directory such as `.github/` or `.gitlab/`. Users should assume the contents of that file will be updated any time the relevant information changes. -To ensure you are adhering to an official version of the specification, please refer to the [latest release](https://github.com/ossf/security-insights/releases/latest). +To ensure you are adhering to an official version of the specification, please refer to the `specification.md` in the [latest release](https://github.com/ossf/security-insights/releases/latest), which is a versioned compilation of all details. This repository often remains unchanged from the latest release, but may diverge as incremental development takes place in preparation for an upcoming release. Any differences between the latest release and the main branch should only be considered previews of the next release. @@ -18,6 +18,13 @@ As the adoption of Security Insights grows, so does the opportunity to automatic ## Maintenance +The specification maintenance occurs in the following places: + +- `specification/`: Contains markdown details for all specification values +- `schema.cue`: Contains the CUE schema that can be used to validate files against the specification +- `template-full.yml`: Contains a template that includes all possible fields +- `template-minimal.yml`: Contains a template that includes only the required fields + Discussion and feedback should take place in [GitHub Issues](https://github.com/ossf/security-insights/issues). Because this specification recieves light maintenance and infrequent updates, beginning in 2025 we ask that you follow the [Security Insights Enhancement Proposal](./docs/GOVERNANCE.md#security-insights-enhancement-proposals) process to explore potential changes to the specification.