From 67a63bc3c0dd2573a05bb25523b2c9f59ecececb Mon Sep 17 00:00:00 2001 From: Al Snow Date: Thu, 8 Jan 2026 16:15:35 -0500 Subject: [PATCH] Improved CONTRIBUTING.md file [skip ci] --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 72681b560e..09a8a515df 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,13 +2,16 @@ * Try to keep all text within 80 columns. * YAML must be indented by 2 spaces. +* Please see the [README](README.md#schema) for more documentation on the + YAML Schema. * `title:` must be a single sentence/line. * `description: |` must contain more than one sentence/line. +* Values for `cvss_v2`, `cvss_v3`, and `cvss_v4` can be found in the reference URLs from [nvd.nist.gov](https://nvd.nist.gov/vuln/search#/nvd/home?resultType=records), [GHSA Advisories](https://github.com/advisories), and the repo's security advisory. * `patched_versions`/`unaffected_versions` version ranges must be quoted (ex: `">= 1.2.3"`). -* Please see the [README](README.md#schema) for more documentation on the - YAML Schema. -* Prior to submitting a pull request, run the tests: +* Prior to submitting a pull request, + * Run [yamlint](https://yamllint.readthedocs.io/en/stable/quickstart.html] to check yaml format + * Run the tests: ``` bundle install