mcore-linting-and-formatting

Original：🇺🇸 English

Translated

Linting and formatting for Megatron-LM. Covers running autoformat.sh, tools (ruff, black, isort, pylint, mypy), and code style rules.

3installs

Sourcenvidia/skills

Added on2026-05-31

NPX Install

npx skill4agent add nvidia/skills mcore-linting-and-formatting

SKILL.md Content

View Translation Comparison →

Linting and Formatting

Running the Formatter

Run before opening a PR:

bash

# Check mode (no changes applied)
BASE_REF=main CHECK_ONLY=true SKIP_DOCS=false bash tools/autoformat.sh

# Fix mode
BASE_REF=main CHECK_ONLY=false bash tools/autoformat.sh

Tools invoked:

black

,

isort

,

pylint

,

ruff

,

mypy

.

Import Ordering

After editing imports in any Python files, always run

uv run isort

on those files before committing:

bash

uv run isort <file1>.py <file2>.py

Setting Up the Linting Group

Inside the container:

bash

uv sync --locked --only-group linting

This installs

ruff

,

black

,

isort

,

pylint

— the same tools used by

tools/autoformat.sh

and CI's

linting

job.

Code Style Rules

Type hints: required on all public API functions. Use
```
X | None
```
, not
```
Optional[X]
```
.
Docstrings: Google-style on all public classes and functions.
Naming: follow Python conventions —
```
snake_case
```
for functions and variables,
```
PascalCase
```
for classes.
Line length: 119 characters (configured in
```
pyproject.toml
```
).
No bare
except
: always catch specific exception types.

mcore-linting-and-formatting

NPX Install

Tags

SKILL.md Content

Linting and Formatting

Running the Formatter

Import Ordering

Setting Up the Linting Group

Code Style Rules