docs: add package README badges#51
Conversation
Signed-off-by: Will Killian <wkillian@nvidia.com>
WalkthroughThe pull request adds project status and version badges to nine README files across the repository root and crate subdirectories, and updates the pre-commit lychee hook to exclude npm package URLs for nemo-flow node and WASM packages from link validation. ChangesPre-commit Configuration Update
Documentation Badges
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Review rate limit: 9/10 reviews remaining, refill in 6 minutes. Comment |
Signed-off-by: Will Killian <wkillian@nvidia.com>
Signed-off-by: Will Killian <wkillian@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@crates/adaptive/README.md`:
- Around line 6-16: The README places the badge block before the H1 "#
nemo-flow-adaptive" which triggers markdownlint MD041; fix by isolating the
badges with localized directives: add a markdownlint-disable for MD041
immediately before the badge block and a markdownlint-enable for MD041
immediately after (or alternatively move the "# nemo-flow-adaptive" H1 above the
badges) so the badge block no longer triggers MD041.
In `@crates/core/README.md`:
- Around line 6-15: The badge block at the top of crates/core/README.md triggers
markdownlint MD041 because it appears before the first H1; fix by either moving
the first H1 "# nemo-flow" above the badge block or wrap the badge block with
markdownlint disable/enable comments (add <!-- markdownlint-disable MD041 -->
before the badges and <!-- markdownlint-enable MD041 --> after them) so the
linter ignores the isolated badges; update the README accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: b65af1a1-a2cd-42fc-9b98-e6dcc28dd801
📒 Files selected for processing (10)
.pre-commit-config.yamlREADME.mdcrates/adaptive/README.mdcrates/core/README.mdcrates/ffi/README.mdcrates/node/README.mdcrates/python/README.mdcrates/wasm/README.mdgo/nemo_flow/README.mdpython/nemo_flow/README.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
- GitHub Check: Go / Test / linux-arm64
- GitHub Check: Go / Test / windows-arm64
- GitHub Check: Go / Test / linux-amd64
- GitHub Check: Go / Test / macos-arm64
- GitHub Check: Python / Test / linux-amd64
- GitHub Check: Go / Test / windows-amd64
- GitHub Check: Python / Test / windows-amd64
- GitHub Check: Python / Test / windows-arm64
- GitHub Check: Python / Test / linux-arm64
- GitHub Check: Python / Test / macos-arm64
- GitHub Check: Documentation / Build
🧰 Additional context used
📓 Path-based instructions (30)
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/core/README.mdcrates/node/README.mdcrates/python/README.mdcrates/adaptive/README.mdcrates/ffi/README.mdREADME.mdcrates/wasm/README.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/core/README.mdcrates/node/README.mdcrates/python/README.mdcrates/adaptive/README.mdcrates/ffi/README.mdREADME.mdcrates/wasm/README.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst,txt}: SpellNVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text. Avoid raw URLs and weak anchors such as 'here' or 'read more.'
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values.
Use numerals for 10 or greater and include commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not add trademark symbols to NeMo Flow learning documentation by default.
Do not rewrite API names, package names, command flags, or code literals for style reasons.
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/core/README.mdcrates/node/README.mdcrates/python/README.mdcrates/adaptive/README.mdcrates/ffi/README.mdREADME.mdcrates/wasm/README.md
**/*.{md,markdown,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.{md,markdown,rst}: Use title case consistently in technical documentation headings
Avoid quotation marks, ampersands, and exclamation marks in headings
Keep product, event, research, and whitepaper names in their official title case
Use title case for table headers
Do not force social-media sentence case into technical docs
Use monospace formatting for code elements, commands, parameters, package names, and expressions
Use monospace formatting for directories, file names, and paths
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Use quotation marks for error messages and strings in documentation
Use bold formatting for UI buttons, menus, fields, and labels in documentation
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use in documentation
Use italics for publication titles in documentation
Use plain text formatting for keyboard shortcuts in documentation
Prefer[NVIDIA/NeMo](link)format for GitHub repository references over generic phrases like 'the GitHub repo'
Introduce every code block with a complete sentence
Do not make a code block complete the grammar of the previous sentence
Do not continue a sentence after a code block
Use syntax highlighting when the format supports it for code blocks
Avoid the word 'snippet' unless the surrounding docs already use it as a term of art
Keep inline method, function, and class references consistent with nearby docs, omitting empty parentheses for prose readability when no call is shown
Use descriptive anchor text that matches the destination title when possible for links
Avoid raw URLs in running text in documentation
Avoid generic link anchors such as 'here,' 'this page,' and 'read more' in documentation
Include the acronym in link text if a linked term includes an acronym
Do not link long sentences or multiple sentences in documentation
Avoid links that pull readers away from a procedure unles...
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/core/README.mdcrates/node/README.mdcrates/python/README.mdcrates/adaptive/README.mdcrates/ffi/README.mdREADME.mdcrates/wasm/README.md
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license headers in HTML and Markdown files using HTML comment syntax
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/core/README.mdcrates/node/README.mdcrates/python/README.mdcrates/adaptive/README.mdcrates/ffi/README.mdREADME.mdcrates/wasm/README.md
**/README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update relevant crate or package README when that surface changed
Relevant package or crate README.md files must be updated when examples or binding guidance changes
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/core/README.mdcrates/node/README.mdcrates/python/README.mdcrates/adaptive/README.mdcrates/ffi/README.mdREADME.mdcrates/wasm/README.md
**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run Markdown link checking via
lycheeforREADME.md,CONTRIBUTING.md, anddocs/through pre-commit hooks
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/core/README.mdcrates/node/README.mdcrates/python/README.mdcrates/adaptive/README.mdcrates/ffi/README.mdREADME.mdcrates/wasm/README.md
**/*.{md,markdown,py,sh,bash,js,ts,java,cpp,go,rust}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repo references, and build commands current in documentation
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/core/README.mdcrates/node/README.mdcrates/python/README.mdcrates/adaptive/README.mdcrates/ffi/README.mdREADME.mdcrates/wasm/README.md
**/*.{md,markdown,py,sh,bash}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep stable user-facing wrappers at scripts/ root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/core/README.mdcrates/node/README.mdcrates/python/README.mdcrates/adaptive/README.mdcrates/ffi/README.mdREADME.mdcrates/wasm/README.md
**/*.{md,markdown,py,sh,bash,js,ts,example}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Example commands must match current package names and paths
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/core/README.mdcrates/node/README.mdcrates/python/README.mdcrates/adaptive/README.mdcrates/ffi/README.mdREADME.mdcrates/wasm/README.md
{docs/**,examples/**,crates/adaptive/**,python/nemo_flow/**,go/nemo_flow/**,**/{example,component}.{ts,tsx,js,rs,py,go}}
📄 CodeRabbit inference engine (.agents/skills/maintain-optimizer/SKILL.md)
Any new adaptive component kind must have documentation, examples, and binding coverage across all supported languages
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/adaptive/README.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Keep documentation and examples synchronized with current install, import, and build commands
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/core/README.mdcrates/node/README.mdcrates/python/README.mdcrates/adaptive/README.mdcrates/ffi/README.mdREADME.mdcrates/wasm/README.md
**/{RELEASING,CHANGELOG,README}.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Point release history and release notes to GitHub Releases, not to
CHANGELOG.mdor docs pages
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/core/README.mdcrates/node/README.mdcrates/python/README.mdcrates/adaptive/README.mdcrates/ffi/README.mdREADME.mdcrates/wasm/README.md
**/*.{md,txt,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
**/*.{md,txt,rst}: Ensure commands, package names, file paths, and APIs in documentation are correct and not stale; flag incorrect or outdated information as blocking issues
Ensure examples and procedures in documentation will execute successfully with current APIs and commands
Use consistent user-facing terminology throughout documentation that matches current repo terminology
Capitalize NVIDIA correctly in all documentation and public-facing text
Format code, commands, paths, and filenames as inline code (monospace) in documentation
Use descriptive anchor text for links instead of bare URLs or weak labels like 'here' in documentation
Prefer active voice, present tense, short sentences, and plain English in documentation
Structure documentation procedures as imperative steps that are easy to scan and not too long for a single sequence
Prefer 'after' instead of 'once' for temporal references in documentation
Use 'can' instead of 'may' when describing possibility (rather than permission) in documentation
Avoid ambiguous numeric dates and ordinal dates in documentation body text
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/core/README.mdcrates/node/README.mdcrates/python/README.mdcrates/adaptive/README.mdcrates/ffi/README.mdREADME.mdcrates/wasm/README.md
{README.md,docs/index.md,**/README.md}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Update entry-point documentation (README.md, docs/index.md, package READMEs, binding-level source READMEs) whenever public behavior changes
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/core/README.mdcrates/node/README.mdcrates/python/README.mdcrates/adaptive/README.mdcrates/ffi/README.mdREADME.mdcrates/wasm/README.md
**/*.{rs,py,js,ts,tsx,jsx,go,sh,yaml,yml,toml,json,md,txt}
📄 CodeRabbit inference engine (AGENTS.md)
Keep SPDX headers on source, docs, scripts, and configuration files. The project is Apache-2.0.
Files:
python/nemo_flow/README.mdgo/nemo_flow/README.mdcrates/core/README.mdcrates/node/README.mdcrates/python/README.mdcrates/adaptive/README.mdcrates/ffi/README.mdREADME.mdcrates/wasm/README.md
python/nemo_flow/**/*
⚙️ CodeRabbit configuration file
python/nemo_flow/**/*: Review Python wrapper changes for typed API consistency, contextvars-based scope isolation, async behavior, and parity with the native extension.
Stubs and runtime implementations should stay aligned.
Files:
python/nemo_flow/README.md
go/nemo_flow/**/*
⚙️ CodeRabbit configuration file
go/nemo_flow/**/*: Review Go binding changes for cgo memory ownership, race safety, callback cleanup, idiomatic exported APIs, and parity with Rust/FFI behavior.
Any API change should include focused Go tests and consider race-test behavior.
Files:
go/nemo_flow/README.md
{crates/core,crates/adaptive}/**
📄 CodeRabbit inference engine (.agents/skills/test-wasm-binding/SKILL.md)
If the change touched shared runtime semantics in
crates/coreorcrates/adaptive, also usevalidate-change
Files:
crates/core/README.mdcrates/adaptive/README.md
crates/{core,adaptive}/**
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If
crates/coreorcrates/adaptivechanged, run the full matrix across Rust, Python, Go, Node.js, and WebAssemblyChanges to
crates/coreorcrates/adaptivemust run the full language matrix
Files:
crates/core/README.mdcrates/adaptive/README.md
crates/{python,ffi,node,wasm}/**/*
⚙️ CodeRabbit configuration file
crates/{python,ffi,node,wasm}/**/*: Treat binding changes as public API changes. Check for parity with the other language bindings, FFI ownership/lifetime safety,
callback error propagation, stable type conversion, and consistent async/stream semantics.
Flag changes that update one binding without corresponding tests or documentation for the same surface elsewhere.
Files:
crates/node/README.mdcrates/python/README.mdcrates/ffi/README.mdcrates/wasm/README.md
{crates/adaptive/**,python/nemo_flow/{adaptive,plugin}.py,go/nemo_flow/{adaptive,**}/*.go,**/*.{ts,js,wasm}}
📄 CodeRabbit inference engine (.agents/skills/maintain-optimizer/SKILL.md)
Keep adaptive config schema, plugin lifecycle, and bindings in sync across crates/adaptive, core, bindings, Python (python/nemo_flow/adaptive.py and python/nemo_flow/plugin.py), Go (go/nemo_flow/adaptive and go/nemo_flow), and Node/WebAssembly helpers
Files:
crates/adaptive/README.md
crates/ffi/**
📄 CodeRabbit inference engine (.agents/skills/test-ffi-surface/SKILL.md)
Rebuild the FFI crate in release mode so the shared library and header stay in sync
Files:
crates/ffi/README.md
{.github/**,.gitlab-ci.yml,.pre-commit-config.yaml,justfile,scripts/**}
⚙️ CodeRabbit configuration file
{.github/**,.gitlab-ci.yml,.pre-commit-config.yaml,justfile,scripts/**}: Review automation changes for reproducibility, pinned versions where appropriate, secret handling, and consistency with the documented validation matrix.
Pay attention to commands that need generated native artifacts, FFI libraries, or platform-specific environment variables.
Files:
.pre-commit-config.yaml
README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update README.md to reflect current workspace members and top-level documentation for changes affecting public behavior, bindings, examples, or workspace structure
Files:
README.md
{README.md,docs/index.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
{README.md,docs/index.md}: Update entry-point docs when examples or reading paths change
README.md or docs/index.md must be updated when entry points change
Files:
README.md
{README*,CHANGELOG*,docs/**/*.{md,rst,txt},examples/**/*,*.md}
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update documentation, examples, and getting-started guides with new package/module/crate names after rename operations
Files:
README.md
{docs/**/*.md,README.md,CONTRIBUTING.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
{docs/**/*.md,README.md,CONTRIBUTING.md}: For docs-only changes, run targeted checks only if commands, package names, or examples changed; usejust docsfor docs-site builds andjust docs-linkcheckwhen links changed
Verify that README and docs entry points match current package names and paths for large or public-facing changes
Files:
README.md
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency across language bindings.
Flag stale examples, missing SPDX headers where required, and instructions that no longer match CI or pre-commit behavior.
Files:
README.md
crates/wasm/**
📄 CodeRabbit inference engine (.agents/skills/test-wasm-binding/SKILL.md)
Run WebAssembly tests with
just test-wasmfor changes incrates/wasm, its JS wrappers, or the WebAssembly-facing runtime surface
Files:
crates/wasm/README.md
🧠 Learnings (1)
📚 Learning: 2026-04-15T18:16:52.951Z
Learnt from: bbednarski9
Repo: NVIDIA/NeMo-Flow PR: 1
File: docs/atof-event-format.md:381-381
Timestamp: 2026-04-15T18:16:52.951Z
Learning: In docs/atof-event-format.md (and when reviewing references to this format across the NeMo-Flow repo), treat `AtifExporter.events_to_steps()` as the intended public/API method name. Do not flag it as inconsistent with internal Rust symbol names (e.g., `event_to_steps` in `crates/core/src/atif.rs`)—the documentation’s public-facing naming may differ intentionally from internal implementation details.
Applied to files:
.pre-commit-config.yaml
🪛 markdownlint-cli2 (0.22.1)
python/nemo_flow/README.md
[warning] 6-6: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
go/nemo_flow/README.md
[warning] 6-6: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
crates/core/README.md
[warning] 6-6: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
crates/node/README.md
[warning] 6-6: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
crates/python/README.md
[warning] 6-6: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
crates/adaptive/README.md
[warning] 6-6: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
crates/ffi/README.md
[warning] 6-6: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
README.md
[warning] 6-6: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
crates/wasm/README.md
[warning] 6-6: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🔇 Additional comments (8)
crates/ffi/README.md (1)
6-15: Badge Block Is Consistent and CorrectThe new badge set is coherent with the package-entrypoint pattern and uses canonical destinations for repo, package, and release surfaces.
crates/wasm/README.md (1)
6-15: Badge Additions Look GoodThis block matches the shared README badge convention and keeps package/release links explicit and readable.
python/nemo_flow/README.md (1)
6-15: Shared Badge Header Is CorrectThe added badges are aligned with the repo-wide badge standard and point to the expected public package and project pages.
README.md (1)
6-15: Root Badge Block Is Well-IntegratedThis change improves top-level project discoverability and remains consistent with the badge pattern used across package READMEs.
crates/python/README.md (1)
6-15: Badge Header Update Looks GoodThe added badges are consistent with the rest of the documentation entry points and use the expected package/release links.
go/nemo_flow/README.md (1)
6-15: Go README Badge Block Is CorrectThe badge additions are consistent with the shared documentation pattern and keep external package/release entry points clear.
crates/node/README.md (1)
6-15: Node README Badge Additions Are SolidThis badge set is consistent, readable, and aligned with the other package-facing README entry points.
.pre-commit-config.yaml (1)
61-62: Lychee Exclusion Scope Is Appropriately NarrowThe regex is tightly anchored to the two known npm package URLs, so link checking remains strict for the rest of the docs.
Overview
Add consistent project badges to the root README and package-published README entry points so repository and registry pages expose release, coverage, package, crate, and DeepWiki links.
Details
www.npmjs.com/package/...package pages.lycheeexclusion for the two npm package-page URLs because npm returns403to linkcheck clients in CI.Validation:
git diff --check -- .pre-commit-config.yaml README.md crates/adaptive/README.md crates/core/README.md crates/ffi/README.md crates/node/README.md crates/python/README.md crates/wasm/README.md go/nemo_flow/README.md python/nemo_flow/README.mdpassed.uv run lychee --no-progress --include-fragments --exclude '^https://www\\.npmjs\\.com/package/nemo-flow-(node|wasm)$' README.md CONTRIBUTING.md docs/**/*.mdpassed with354 OKand2 Excluded.uv run pre-commit run --files .pre-commit-config.yaml README.md crates/adaptive/README.md crates/core/README.md crates/ffi/README.md crates/node/README.md crates/python/README.md crates/wasm/README.md go/nemo_flow/README.md python/nemo_flow/README.mdpassed.Where should the reviewer start?
Start with
README.mdto review the shared badge block, then compare the copied block in the package-facing README files and the narrowlycheeexclusion in.pre-commit-config.yaml.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit
Documentation
Chores