Skip to content

chore: add AGENTS.md - #2055

Open
cdesiniotis wants to merge 1 commit into
NVIDIA:mainfrom
cdesiniotis:add-agentsmd
Open

chore: add AGENTS.md#2055
cdesiniotis wants to merge 1 commit into
NVIDIA:mainfrom
cdesiniotis:add-agentsmd

Conversation

@cdesiniotis

Copy link
Copy Markdown
Contributor

Description

This PR adds an AGENTS.md file to help AI coding agents contribute to the project. The overall structure of this file takes inspiration from existing projects, namely https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/blob/main/AGENTS.md. We can definitely fine-tune this file over time.

This addresses SIG-AGT-01, SIG-AGT-13, SIG-AGT-03, SIG-AGT-04, SIG-AGT-05, SIG-AGT-06, SIG-AGT-14, SIG-AGT-15, and SIG-AGT-16. from the OSS Scorecard.

Checklist

  • No secrets, sensitive information, or unrelated changes
  • Unit tests passing (make test)
  • Lint checks passing (make lint)
  • Test cases are added for new code paths
  • Commits are signed-off and cryptographically signed

Testing

OSS scorecard was run with and without this change.

Signed-off-by: Christopher Desiniotis <cdesiniotis@nvidia.com>
@cdesiniotis cdesiniotis self-assigned this Sep 8, 2026

@tariq1890 tariq1890 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we add a line advising against highly verbose comments ?

@cdesiniotis

Copy link
Copy Markdown
Contributor Author

Can we add a line advising against highly verbose comments ?

Sure. Below is what we currently have under Coding Conventions. Maybe we can expand on this to explicitly discourage verbose comments. Let me know if you have any suggestions on wording.

Comments explain **why**, not  **what**. Identifier names should carry the "what."

@tariq1890

Copy link
Copy Markdown
Contributor

I missed that. I think that should be good enough for now. If we find that Agent-generated PRs are still riddled with a lot of comments, we can then refine the AGENTS.md further.

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.

2 participants