Update contributing guide
This commit is contained in:
+2
-1
@@ -38,6 +38,7 @@ _Note_: We don't have any useful tests yet, contributions are welcome!
|
|||||||
|
|
||||||
## Local Development
|
## Local Development
|
||||||
|
|
||||||
|
It is recommended to have atleast [Node 18](https://nodejs.org/en/) installed.
|
||||||
We have a script to scan a given PR for vulnerabilities, this will
|
We have a script to scan a given PR for vulnerabilities, this will
|
||||||
help you test your local changes. Make sure to [grab a Personal Access Token (PAT)](https://github.com/settings/tokens) before proceeding (you'll need `repo` permissions for private repos):
|
help you test your local changes. Make sure to [grab a Personal Access Token (PAT)](https://github.com/settings/tokens) before proceeding (you'll need `repo` permissions for private repos):
|
||||||
|
|
||||||
@@ -56,7 +57,7 @@ $ GITHUB_TOKEN=my-secret-token ./scripts/scan_pr https://github.com/actions/depe
|
|||||||
```
|
```
|
||||||
|
|
||||||
[Configuration options](README.md#configuration-options) can be set by
|
[Configuration options](README.md#configuration-options) can be set by
|
||||||
passing an external YAML [configuration file](README.md#configuration-file) to the
|
passing an external YAML [configuration file](README.md#configuration-file) to the
|
||||||
`scan_pr` script with the `-c`/`--config-file` option:
|
`scan_pr` script with the `-c`/`--config-file` option:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
|
|||||||
Reference in New Issue
Block a user