Skip to content

Add dev environment and review process info to CONTRIBUTING.md - #2861

Open
cdesiniotis wants to merge 3 commits into
NVIDIA:mainfrom
cdesiniotis:improvements-to-contrib-guide
Open

Add dev environment and review process info to CONTRIBUTING.md#2861
cdesiniotis wants to merge 3 commits into
NVIDIA:mainfrom
cdesiniotis:improvements-to-contrib-guide

Conversation

@cdesiniotis

Copy link
Copy Markdown
Contributor

Description

The changes in this PR address SIG-CON-08 and SIG-CON-10 from OSS Scorecard.

Checklist

  • No secrets, sensitive information, or unrelated changes
  • Lint checks passing (make lint)
  • Generated assets in-sync (make validate-generated-assets)
  • Go mod artifacts in-sync (make validate-modules)
  • Test cases are added for new code paths

Testing

The OSS Scorecard was run before and after these changes.

Signed-off-by: Christopher Desiniotis <cdesiniotis@nvidia.com>
Signed-off-by: Christopher Desiniotis <cdesiniotis@nvidia.com>
Signed-off-by: Christopher Desiniotis <cdesiniotis@nvidia.com>
@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The pull request expands CONTRIBUTING.md with pull request requirements, development prerequisites, tool installation, and common make targets. It adds golang.org/x/tools v0.47.0 and its indirect telemetry dependency to tools/go.mod. It registers goimports in tools/tools.go.

Merge Risk: 🔵 Low · up to cc1b8

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 💡
  • Resolve merge conflict in branch improvements-to-contrib-guide

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 win

Describe make fmt correctly.

Makefile:205-208 runs gofmt -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 output
CONTRIBUTING.md-115-115 (1)

115-115: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Use the existing Make target name.

The Makefile defines generate-clientset in the singular. make generate-clientsets fails 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

📥 Commits

Reviewing files that changed from the base of the PR and between 3040f33 and cc1b89e.

⛔ Files ignored due to path filters (1)
  • tools/go.sum is excluded by !**/*.sum
📒 Files selected for processing (3)
  • CONTRIBUTING.md
  • tools/go.mod
  • tools/tools.go

Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review.

@cdesiniotis
cdesiniotis force-pushed the improvements-to-contrib-guide branch from cc1b89e to 79bfe55 Compare September 4, 2026 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant