Model-Optimizer/CLAUDE.md at main

trending/Model-Optimizer

Fork 0

mirror of https://github.com/NVIDIA/Model-Optimizer.git synced 2026-10-02 03:14:52 +08:00

Files

T

realAsma e27f76fbfe Refine agent contribution guidance (#1488 )

### What does this PR do?

Type of change: documentation.

This PR centralizes repository agent guidance around `AGENTS.md` as the
shared
entrypoint. `CLAUDE.md` now points to `AGENTS.md`, while detailed coding
principles and tool-specific setup notes live under `.agents/`.

Key changes:

- Add `AGENTS.md` as the shared repository agent instructions file.
- Point `CLAUDE.md` at `AGENTS.md` so Claude Code reads the same
entrypoint.
- Add `.agents/developer-guidelines.md` for production code and review
principles, including minimal changes, extension points, testing,
performance,
and compatibility expectations.
- Add `.agents/TOOLING.md` for human-maintained notes about local agent
overrides and shared instruction maintenance.
- Update the Claude review workflow to read `AGENTS.md` and
`.agents/developer-guidelines.md`.
- Update contributor and README guidance with focused local validation
examples
and an AI-agent pointer.
- Ignore local agent override files.

### Usage

N/A. Documentation-only change.

### Testing

- `git diff --check`
- Commit pre-commit hooks passed, including `markdownlint-cli2`.
- GitHub PR checks passed, including code quality, docs, unit Linux,
required
gate checks, DCO, CodeRabbit, and Codecov.

### Before your PR is "*Ready for review*"

Make sure you read and follow [Contributor
guidelines](https://github.com/NVIDIA/Model-Optimizer/blob/main/CONTRIBUTING.md)
and your commits are signed (`git commit -s -S`).

Make sure you read and follow the [Security Best
Practices](https://github.com/NVIDIA/Model-Optimizer/blob/main/SECURITY.md#security-coding-practices-for-contributors)
(e.g. avoiding hardcoded `trust_remote_code=True`, `torch.load(...,
weights_only=False)`, `pickle`, etc.).

- Is this change backward compatible?: N/A
- If you copied code from any other sources or added a new PIP
dependency, did you follow guidance in `CONTRIBUTING.md`: N/A
- Did you write any new necessary tests?: N/A
- Did you update
[Changelog](https://github.com/NVIDIA/Model-Optimizer/blob/main/CHANGELOG.rst)?:
N/A
- Did you get Claude approval on this PR?: N/A

### Additional Information

Docs-only agent guidance update.

## Summary by CodeRabbit

* **Documentation**
* Added comprehensive AI-agent instructions, developer guidelines, and
tooling notes for AI-assisted workflows.
* Updated contribution docs with clearer test-running guidance and
linked agent resources from the main README.
* Adjusted the code-review workflow to reference the new guidance
materials.
* **Chores**
* Updated ignore rules to exclude local agent override files.

---------

Signed-off-by: realAsma <akuriparambi@nvidia.com>

2026-05-14 11:55:15 -07:00

Symbolic link

9 B

Raw Permalink Blame History

AGENTS.md

Symbolic link 9 B Raw Permalink Blame History

Symbolic link

9 B

Raw Permalink Blame History