-
-
Notifications
You must be signed in to change notification settings - Fork 225
Added more info about PR prep to CONTRIBUTING.md file #948
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,20 @@ | ||
| # Contributing Guidelines | ||
|
|
||
| * Try to keep all text within 80 columns. | ||
| * YAML must be indented by 2 spaces. | ||
| * `title:` must be a single sentence/line. | ||
| * `description: |` must contain more than one sentence/line. | ||
| * `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: | ||
| * Values for 'cvss_v2', 'cvss_v3', and 'cvss_v4' can be found in | ||
| the reference URLs from nvd.nist.gov, https://github.com/advisories, | ||
| and the repo's security advisory. | ||
| * Prior to submitting a pull request, | ||
| * Run yamlint to check yaml format | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| * https://yamllint.readthedocs.io/en/stable | ||
| * YAML must be indented by 2 spaces. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This line should stay at the top. |
||
| * Please see the [README](README.md#schema) for more documentation on the | ||
| YAML Schema. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This bullet point should stay at the top, below the other YAML schema recommendations. |
||
| * Run the tests and see that it is clean: | ||
|
|
||
| ``` | ||
| bundle install | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be formatted similar to the above comments about
title:.Also, it might be easier to link directly to NVD's search form, as well as GitHub Advisories.