Skip to content

Commit e198ae8

Browse files
Heiko KieselZero3141
authored andcommitted
Adjust new hook issue template
Signed-off-by: Heiko Kiesel <heiko.kiesel@iteratec.com>
1 parent d0b0ba7 commit e198ae8

1 file changed

Lines changed: 6 additions & 7 deletions

File tree

.github/ISSUE_TEMPLATE/new_hook.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,10 @@ Before opening a new issue, please make sure that we do not have any duplicates
3131
## Steps to implement a new hook
3232
Hint: A general guide how to implement a new SCB Hook is documented [here](https://www.securecodebox.io/docs/contributing/integrating-a-hook)
3333

34-
- [ ] Create a new folder with the name of the [hook here](https://github.com/secureCodeBox/secureCodeBox/tree/master/hooks)
35-
- [ ] Add a `README.md` and give a brief overview of the scanner and its configuration options.
36-
- [ ] Add a HelmChart and document all configuration options.
37-
- [ ] Add (optional) a `Dockerfile` for the scanner if there is no existing one publicly available on dockerHub.io
38-
- [ ] Use the [Hook-SDK](https://github.com/secureCodeBox/secureCodeBox/tree/master/hook-sdk) to implement a new hook (currently based on NodeJS)
39-
- [ ] Add unit tests with at minimum 80% test coverage
40-
- [ ] Add some example `scan.yaml` and `finding.yaml` files in the example folder
34+
- [ ] Create a new Helm Chart with the `helm create new-hook` command (replace `new-hook` with the name of the hook)
35+
- [ ] Add a basic description of your hook Helm chart in the `Chart.yaml`
36+
- [ ] (optional) Add/Edit fields in `values.yaml`
37+
- [ ] 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)
38+
- [ ] Implement the hook in `hook.js` and test it in `hook.test.js`
4139
- [ ] 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)
40+
- [ ] Add a brief overview of the scanner and its configuration options in `.helm-docs.gotmpl`

0 commit comments

Comments
 (0)