Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 10 additions & 4 deletions CONTRIBUTING.md
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
Copy link
Member

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.

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
Copy link
Member

Choose a reason for hiding this comment

The 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.
Copy link
Member

Choose a reason for hiding this comment

The 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.
Copy link
Member

Choose a reason for hiding this comment

The 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
Expand Down
8 changes: 8 additions & 0 deletions spec/spec_helper.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
require 'strscan'

class StringScanner
def peep(len)
peek(len)
end
end

require 'date'
require 'kwalify'
require 'rspec'
Expand Down