Improve documentation #125
Conversation
Signed-off-by: Dan Luhring <dan.luhring@anchore.com>
Signed-off-by: Dan Luhring <dan.luhring@anchore.com>
CONTRIBUTING.md
Outdated
| This project has a `Makefile` which includes many helpers running both unit and integration tests. Although PRs will have automatic checks for these, it is useful to run them locally, ensuring they pass before submitting changes. Ensure you've bootstrapped once before running tests: | ||
|
|
||
| ```text | ||
| $ make bootstrap | ||
| ``` | ||
|
|
||
| You only need to bootstrap once. After the bootstrap process, you can run the tests as many times as needed: | ||
|
|
||
| ```text | ||
| $ make unit | ||
| $ make integration | ||
| ``` |
There was a problem hiding this comment.
This isn't quite right, should possibly just reference Developing tests
There was a problem hiding this comment.
Great catch — yeah, this is wrong. That hyperlink doesn't quite work for me when I try clicking it, but I'll try to find the relevant section...
| @@ -1,6 +1,9 @@ | |||
| [![Test Status][test-img]][test] | |||
| # GitHub Action for Vulnerability Scanning | |||
There was a problem hiding this comment.
I thought I saw elsewhere we were going for sentence case? Or possibly since this is the title, we have an exception for title case?
There was a problem hiding this comment.
@kzantow I don't have a strong opinion! Since this is the title of the README itself, I chose this case, but I'm happy to change it! Let me know. (What was there before was a capital "S" in "scanning", but a lowercase "v" in "vulnerability")
Signed-off-by: Dan Luhring <dan.luhring@anchore.com>
CONTRIBUTING.md
Outdated
|
|
||
| ## Test your changes | ||
|
|
||
| Ensure that your changes have passed the test suite. For more information on working with this project's tests, see https://github.com/anchore/scan-action/tree/main/tests#developing-tests. |
There was a problem hiding this comment.
Just an FYI... I'm pretty sure if you end up viewing this file, you'll be at a URL like: https://github.com/anchore/scan-action/blob/main/CONTRIBUTING.md and the test readme is then https://github.com/anchore/scan-action/blob/main/tests/README.md, so the relative URL of tests/README.md#title should work, although it won't in PRs because you're at https://github.com/anchore/scan-action/pull/125/files
There was a problem hiding this comment.
And if you go to View file:
I think those relative links work, too.
There was a problem hiding this comment.
@kzantow Okay, this is good to know... do you see it as a good idea to change the kind of link here? (curious what the pros/cons are)
There was a problem hiding this comment.
I think relative links are best, so you could potentially review a PR with changes across them otherwise you're linking back to master. Not a strong opinion, but lean towards relative links when possible.
There was a problem hiding this comment.
I'll ask for forgiveness 😁
Signed-off-by: Dan Luhring <dan.luhring@anchore.com>
This PR improves scan-action's documentation in the following ways:
README.mdCONTRIBUTING.rstwith our standardCONTRIBUTING.md(and its new content)