Conversation
AGENTS.md
Outdated
| ## Coding Conventions | ||
|
|
||
| See [`STYLE_GUIDE.md`](STYLE_GUIDE.md) for detailed conventions. Key points: | ||
|
|
There was a problem hiding this comment.
if we omit repeating the details, will it lead to a lower quality of help?
There was a problem hiding this comment.
We could ask AI if it makes a difference and see what it says. 😆 It should "just work" if we say "make sure to look at STYLE_GUIDE.md to ensure changes meet the expected style of the codebase".
There was a problem hiding this comment.
Pull request overview
Adds a root-level AGENTS.md following the agents.md spec to provide AI coding agents with structured repository context (architecture summary, repo layout, common commands, and key conventions).
Changes:
- Introduces
AGENTS.mdwith an overview of NICo, repo structure, and technology stack. - Documents common build/test/lint workflows (primarily
cargo-maketasks). - Summarizes coding conventions and operational/CI expectations with links to existing docs.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
AGENTS.md
Outdated
| - Hardware inventory management and orchestration | ||
| - Redfish-based hardware management | ||
| - Hardware testing and firmware updates | ||
| - IPv4 address allocation and DNS services |
There was a problem hiding this comment.
It might throw an agent off if it sees IPv4 here, but also sees I'm deep into IPv6 support. It might be good to say "IP address allocation" here so agents have awareness that changes it makes should take IPv6 into consideration (if it doesn't find it, anyway),
AGENTS.md
Outdated
| git commit -s -m "Your commit message" | ||
| ``` | ||
|
|
||
| DCO compliance is enforced automatically; unsigned commits block merging. |
There was a problem hiding this comment.
Also commits must be GPG or SSH key signed
There was a problem hiding this comment.
squashed and one verified ssh signed commit
There was a problem hiding this comment.
GPG Signing only applies to Nvidia folks? That would not apply to community contributions.
There was a problem hiding this comment.
I imagine not many people have proper gpg signing configuration.
Signed-off-by: Terry Howe <terrylhowe@gmail.com>
TerryHowe
force-pushed
the
copilot/create-agents-md-file
branch
from
11c2a07 to
d75d130
Compare
|
I don't want to hold up the merge or this MR, so we can add this after the merge. Here are a few I picked up from other open source projects Git workflowWhen writing git commit messages, follow the conventions below: Make sure you use git mv to move any files that are already checked into When writing commit messages, ensure that you explain any non-obvious Wrap any prose (but not code) in the commit message to match git commit When you refer to types or very short code snippets, place them in Code style preferencesDocument when you have intentionally omitted code that the reader might Add TODO comments for features or nuances that were deemed not important |
The per-crate directory listing in the tree would require ongoing maintenance as crates are added or removed. Replace it with a note directing agents to discover crates dynamically via `ls crates/` or the workspace members in `Cargo.toml`. Signed-off-by: Terry Howe <terrylhowe@gmail.com>
TerryHowe
force-pushed
the
copilot/create-agents-md-file
branch
from
12915ea to
ec043e0
Compare
Signed-off-by: Terry Howe <terrylhowe@gmail.com>
Description
Adds a root-level AGENTS.md per the agents.md spec to give AI coding agents structured, scannable context about this repo.
Type of Change
Related Issues (Optional)
N/A
Breaking Changes
Testing
Additional Notes