Skip to content

Commit abb88ce

Browse files
authored
AGENTS.md: Add pre-commit command to existing CI requirements line (#7930)
## Summary - Added explicit `pre-commit run --files <changed_files>` command to the existing CI requirements line in AGENTS.md/CLAUDE.md - Clarifies that only modified files should be checked, not the entire codebase ## Changes - Enhanced the existing pre-commit bullet point in "Commit & CI requirements" section (no new section added) Signed-off-by: Guokai Ma <guokai.ma@intel.com>
1 parent 729df6c commit abb88ce

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
- All commits MUST have a `Signed-off-by` line (use `--signoff`). Get the name and email from `git config user.name` / `git config user.email`.
99
- Formatting: yapf (column_limit=119, `.style.yapf`) + flake8 (`.flake8`).
10-
- Always verify changed files pass pre-commit checks before committing. Config: `.pre-commit-config.yaml`.
10+
- Always verify changed files pass pre-commit checks before committing: `pre-commit run --files <changed_files>`. Only check modified files, not the entire codebase. Config: `.pre-commit-config.yaml`.
1111
- `check-torchdist` hook: NEVER directly import torch's distributed module. Use `import deepspeed.comm as dist` instead.
1212
- New files require license header:
1313
```

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
- All commits MUST have a `Signed-off-by` line (use `--signoff`). Get the name and email from `git config user.name` / `git config user.email`.
99
- Formatting: yapf (column_limit=119, `.style.yapf`) + flake8 (`.flake8`).
10-
- Always verify changed files pass pre-commit checks before committing. Config: `.pre-commit-config.yaml`.
10+
- Always verify changed files pass pre-commit checks before committing: `pre-commit run --files <changed_files>`. Only check modified files, not the entire codebase. Config: `.pre-commit-config.yaml`.
1111
- `check-torchdist` hook: NEVER directly import torch's distributed module. Use `import deepspeed.comm as dist` instead.
1212
- New files require license header:
1313
```

0 commit comments

Comments
 (0)