Add dev environment and review process info to CONTRIBUTING.md - #2861
Add dev environment and review process info to CONTRIBUTING.md#2861cdesiniotis wants to merge 3 commits into
Conversation
Signed-off-by: Christopher Desiniotis <cdesiniotis@nvidia.com>
Signed-off-by: Christopher Desiniotis <cdesiniotis@nvidia.com>
Signed-off-by: Christopher Desiniotis <cdesiniotis@nvidia.com>
📝 WalkthroughWalkthroughThe pull request expands Merge Risk: 🔵 Low · up to The new contributor guidance includes one non-mutating formatting command described as applying changes and one nonexistent clientset command. This can misdirect contributors and block documented workflow steps; correct the documentation before merge. ✨ Finishing Touches 💡 1⚔️ Resolve merge conflicts 💡
Comment |
There was a problem hiding this comment.
Note
Quiet mode is enabled, so only the most important comments were posted inline. Other review comments are grouped below.
🟡 Other comments (2)
CONTRIBUTING.md-107-107 (1)
107-107: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winDescribe
make fmtcorrectly.
Makefile:205-208runsgofmt -s -l -d. It lists files and prints diffs. It does not write formatted files. Change this description to “check formatting” or update the target to use-w.Proposed documentation fix
-make fmt # apply gofmt to codebase +make fmt # check gofmt outputCONTRIBUTING.md-115-115 (1)
115-115: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winUse the existing Make target name.
The Makefile defines
generate-clientsetin the singular.make generate-clientsetsfails because that target does not exist. Rename the documented command.Proposed documentation fix
-make generate-clientsets # generate clientsets for APIs +make generate-clientset # generate clientset for APIs
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: QUIET
Plan: Enterprise
Run ID: d8c2a0db-9451-4f8e-a5bc-668b8a7b4015
⛔ Files ignored due to path filters (1)
tools/go.sumis excluded by!**/*.sum
📒 Files selected for processing (3)
CONTRIBUTING.mdtools/go.modtools/tools.go
Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review.
cc1b89e to
79bfe55
Compare
Description
The changes in this PR address SIG-CON-08 and SIG-CON-10 from OSS Scorecard.
Checklist
make lint)make validate-generated-assets)make validate-modules)Testing
The OSS Scorecard was run before and after these changes.