Added more info about PR prep to CONTRIBUTING.md file #948
Conversation
postmodern
left a comment
postmodern
left a comment
There was a problem hiding this comment.
I like the idea of recommending running yamllint in addition to running the specs. However, some of the bullet points got moved around and the markdown formatting could be a bit better.
| * 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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
yamllint should be a markdown link to https://yamllint.readthedocs.io/en/stable/quickstart.html or https://pypi.org/project/yamllint/.
| * Prior to submitting a pull request, | ||
| * Run yamlint to check yaml format | ||
| * https://yamllint.readthedocs.io/en/stable | ||
| * YAML must be indented by 2 spaces. |
There was a problem hiding this comment.
This line should stay at the top.
| * https://yamllint.readthedocs.io/en/stable | ||
| * YAML must be indented by 2 spaces. | ||
| * Please see the [README](README.md#schema) for more documentation on the | ||
| YAML Schema. |
There was a problem hiding this comment.
This bullet point should stay at the top, below the other YAML schema recommendations.
|
Too confusing so closing PR. |
2 participants
Added more info about PR prep to CONTRIBUTING.md file.