Skip to content

Improve issue templates #1874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Zero3141 merged 3 commits into from
Aug 25, 2023
Merged

Improve issue templates #1874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0da3db3
Adjust security scanner integration issue template
Aug 23, 2023
bfe89bc
Adjust new hook issue template
Aug 23, 2023
6fcfbbb
Clarify the directory in which to run the commands
Aug 25, 2023
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
13 changes: 6 additions & 7 deletions .github/ISSUE_TEMPLATE/new_hook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,10 @@ Before opening a new issue, please make sure that we do not have any duplicates
## Steps to implement a new hook
Hint: A general guide how to implement a new SCB Hook is documented [here](https://www.securecodebox.io/docs/contributing/integrating-a-hook)

- [ ] Create a new folder with the name of the [hook here](https://github.com/secureCodeBox/secureCodeBox/tree/master/hooks)
- [ ] Add a `README.md` and give a brief overview of the scanner and its configuration options.
- [ ] Add a HelmChart and document all configuration options.
- [ ] Add (optional) a `Dockerfile` for the scanner if there is no existing one publicly available on dockerHub.io
- [ ] Use the [Hook-SDK](https://github.com/secureCodeBox/secureCodeBox/tree/master/hook-sdk) to implement a new hook (currently based on NodeJS)
- [ ] Add unit tests with at minimum 80% test coverage
- [ ] Add some example `scan.yaml` and `finding.yaml` files in the example folder
- [ ] Create a new Helm Chart with the `helm create new-hook` command in the `hooks` directory (replace `new-hook` with the name of the hook)
- [ ] Add a basic description of your hook Helm chart in the `Chart.yaml`
- [ ] (optional) Add/Edit fields in `values.yaml`
- [ ] Add (optional) a `Dockerfile` for the hook if you do not use the provided [hook-sdk](https://github.com/secureCodeBox/secureCodeBox/tree/main/hook-sdk/nodejs)
- [ ] Implement the hook in `hook.js` and test it in `hook.test.js`
- [ ] Implement a [new integration or E2E test](https://www.securecodebox.io/docs/contributing/integrating-a-hook/integration-tests) for the hook [here](https://github.com/secureCodeBox/secureCodeBox/tree/master/tests/integration)
- [ ] Add a brief overview of the scanner and its configuration options in `.helm-docs.gotmpl`
17 changes: 8 additions & 9 deletions .github/ISSUE_TEMPLATE/new_security_scanner.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,13 @@ Before opening a new issue, please make sure that we do not have any duplicates
## Steps to implement a new scanner
Hint: A general guide how to implement a new SCB scanner is documented [here](https://www.securecodebox.io/docs/contributing/integrating-a-scanner)

- [ ] Create a new folder with the name of the [scanner here](https://github.com/secureCodeBox/secureCodeBox/tree/master/scanners)
- [ ] Add a `README.gotmpl` and give a [brief overview](https://www.securecodebox.io/docs/contributing/integrating-a-scanner/readme) of the scanner and its configuration options.
- [ ] Add a HelmChart and document all configuration options.
- [ ] Implement a new scanner specific `scan-type.yaml`
- [ ] Implement a new scanner specific `parse-definition.yaml`
- [ ] Add (optional) some `cascading-rules.yaml` like documented [here](https://www.securecodebox.io/docs/api/crds/cascading-rule)
- [ ] Add (optional) a `Dockerfile` for the scanner if there is no existing one publicly available on dockerHub
- [ ] Use the [parser-SDK](https://github.com/secureCodeBox/secureCodeBox/tree/master/parser-sdk) to implement a new findings parser (currently based on NodeJS)
- [ ] Create a new Helm Chart with the `make create-new-scanner NAME=new-scanner` command in the project directory (replace `new-scanner` with the name of the scanner)
- [ ] Add a basic description of your scanner Helm chart in the `Chart.yaml`
- [ ] (optional) Add/Edit fields in `values.yaml`
- [ ] (optional) Add some cascading rules, see [here](https://www.securecodebox.io/docs/api/crds/cascading-rule/)
- [ ] Add (optional) a `Dockerfile` for the scanner if there is no existing one publicly available on DockerHub in the `scanner` directory
- [ ] Use the [parser-SDK](https://github.com/secureCodeBox/secureCodeBox/tree/main/parser-sdk) to implement a new findings parser (currently based on NodeJS) in the `parser` directory
- [ ] Add unit tests with at minimum 80% test coverage
- [ ] Add some example `scan.yaml` and `finding.yaml` files in the [example folder](https://www.securecodebox.io/docs/contributing/integrating-a-scanner/examples-dir)
- [ ] Implement a [new integration or E2E test](https://www.securecodebox.io/docs/contributing/integrating-a-scanner/integration-tests) for the hook [here](https://github.com/secureCodeBox/secureCodeBox/tree/master/tests/integration)
- [ ] Implement a [new integration or E2E test](https://www.securecodebox.io/docs/contributing/integrating-a-scanner/integration-tests) for the hook [here](https://github.com/secureCodeBox/secureCodeBox/tree/main/tests/integration)
- [ ] Add a brief overview of the scanner and its configuration options in `.helm-docs.gotmpl`