Skip to content
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

Jump to bottom

docs: Reference exceptions in CONTRIBUTING.md #367

Merged
merged 1 commit into from
Oct 20, 2024
Merged

docs: Reference exceptions in CONTRIBUTING.md #367

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ As adding new orphaned resources capabilities requires the addition or modificat
├── cmd/kor
│ └── <resource>s.go
├── pkg/kor
│ ├── <resource>s
│ │ └── <resource>s.json
│ ├── all.go
│ ├── create_test_resources.go
│ ├── delete.go
Expand All @@ -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 \<resource>.
- `pkg/kor/multi.go` - allow finding your new resource in a comma-separated query along other resources.
- `pkg/kor/exceptions/<resource>s/<resource>s.json` - list default unused instances of type \<resource> to avoid false-positive results.
- `cmd/kor/<resource>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`.
Expand Down