From cc6d25165234285d9c90e5b837cb41457d382273 Mon Sep 17 00:00:00 2001 From: cnagadya Date: Fri, 28 Oct 2022 09:54:53 +0000 Subject: [PATCH] Update contributing guide --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 67c17e3..42c5100 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,6 +38,7 @@ _Note_: We don't have any useful tests yet, contributions are welcome! ## 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 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,11 +57,11 @@ $ GITHUB_TOKEN=my-secret-token ./scripts/scan_pr https://github.com/actions/depe ``` [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: ```sh -$ GITHUB_TOKEN= ./scripts/scan_pr --config-file my_custom_config.yml +$ GITHUB_TOKEN= ./scripts/scan_pr --config-file my_custom_config.yml ``` ## Submitting a pull request