From a9b029259576dbef26f394ca605930d913a39be1 Mon Sep 17 00:00:00 2001 From: Doron KG <70585638+doronkg@users.noreply.github.com> Date: Sun, 20 Oct 2024 21:58:14 +0300 Subject: [PATCH] docs: Reference exceptions in CONTRIBUTING.md --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a5df3fb4..285d958c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,6 +41,8 @@ As adding new orphaned resources capabilities requires the addition or modificat ├── cmd/kor │ └── s.go ├── pkg/kor +│ ├── s +│ │ └── s.json │ ├── all.go │ ├── create_test_resources.go │ ├── delete.go @@ -56,6 +58,7 @@ As adding new orphaned resources capabilities requires the addition or modificat - `pkg/kor/all.go` - add your new resource to `kor all` command to map all unused resources. - `pkg/kor/delete.go` - add a deletion functionality to apply on unused instances of type \. - `pkg/kor/multi.go` - allow finding your new resource in a comma-separated query along other resources. +- `pkg/kor/exceptions/s/s.json` - list default unused instances of type \ to avoid false-positive results. - `cmd/kor/s.go` - add your new functionanilities to `kor` command-line. - `charts/kor/templates/role.yaml` - grant get/list/watch permissions to the new resource in a namespaces/cluster-scoped level. - `README.md` - introduce your added capabilities to `kor`.