Skip to content

Improved CONTRIBUTING.md file [skip ci] #951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jasnow wants to merge 1 commit into from
Closed

Improved CONTRIBUTING.md file [skip ci] #951

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down