yonahd / kor

A Golang Tool to discover unused Kubernetes Resources
MIT License
974 stars 91 forks source link

Feature: Add contributing.md to the repo #164

Closed yonahd closed 7 months ago

yonahd commented 10 months ago

Add a CONTRIBUTING.md file to Kor repository

mzsrtgzr2 commented 10 months ago

give me that thanks

doronkg commented 8 months ago

As adding new orphaned resources capabilities requires the addition/modification of multiple files in the repo, it'd be quite beneficial for new contributors if all were listed properly under CONTRIBUTING.md with some level of elaboration.

If I'm not mistaken, this would be the list:

.
├── cmd/kor
│   └── <resource>s.go
├── pkg/kor
│   ├── all.go
│   ├── create_test_resources.go
│   ├── delete.go
│   ├── multi.go
│   ├── <resource>s.go
│   └── <resource>s_test.go
└── README.md
yonahd commented 8 months ago

As adding new orphaned resources capabilities requires the addition/modification of multiple files in the repo, it'd be quite beneficial for new contributors if all were listed properly under CONTRIBUTING.md with some level of elaboration.

If I'm not mistaken, this would be the list:

.
├── cmd/kor
│   └── <resource>s.go
├── pkg/kor
│   ├── all.go
│   ├── create_test_resources.go
│   ├── delete.go
│   ├── multi.go
│   ├── <resource>s.go
│   └── <resource>s_test.go
└── README.md

100% agree.

yonahd commented 8 months ago

@mzsrtgzr2 do you intend to work on this or should I open it up to a different contributor?

doronkg commented 8 months ago

As adding new orphaned resources capabilities requires the addition/modification of multiple files in the repo, it'd be quite beneficial for new contributors if all were listed properly under CONTRIBUTING.md with some level of elaboration.

If I'm not mistaken, this would be the list:

.
├── cmd/kor
│   └── <resource>s.go
├── pkg/kor
│   ├── all.go
│   ├── create_test_resources.go
│   ├── delete.go
│   ├── multi.go
│   ├── <resource>s.go
│   └── <resource>s_test.go
└── README.md

Also in:

 .
 └── charts/kor/templates
     └── role.yaml