Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
Signed-off-by: Eddie Knight <[email protected]>
  • Loading branch information
eddie-knight committed Dec 30, 2024
1 parent eaf5167 commit b6b7ed6
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
File renamed without changes.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,21 @@ 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.

As the adoption of Security Insights grows, so does the opportunity to automatically ingest it. For example, the Linux Foundation's [CLOMonitor](https://clomonitor.io/) parses a project's Security Insights file to determine whether projects have reported on select security factors prioritized by the foundation.

## 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.

0 comments on commit b6b7ed6

Please sign in to comment.