You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In PR #1313, we explored adding docs/tooling configs (markdownlint, dprint, lychee, typos). @GideonBear asked for a narrower scope—avoiding content churn (e.g., locales and OS-release)—and preferred pre-commit/pre-commit-ci over GitHub Actions for docs/lint.
The PR was closed with a request to realign. This RFC proposes two concrete approaches and asks maintainers to choose.
Goals and Constraints
Keep Rust formatting via rustfmt as the single source of truth
Avoid automated edits to sensitive content (locales, OS-release fingerprints)
Keep contributor workflow simple and fast across platforms (Windows included)
Minimize ecosystem sprawl and CI noise
🅰️ Option A — cargo-first (single entrypoint, fast, reproducible)
Orchestrate checks via cargo (xtask or cargo-make):
CI: One job calls the same cargo tasks; lychee also runs on a weekly schedule.
Conservative excludes for translations and OS-release files to prevent false positives.
Why: Single toolchain, Rust-native CLIs are fast, cross-platform, reproducible, and caching is straightforward.
🅱️ Option B — Align with @GideonBear (pre-commit-first, minimal scope)
Keep rustfmt/clippy for Rust
Use pre-commit/pre-commit-ci for typos and ShellCheck
Maintain .typos.toml with excludes for locales/** and src/steps/os/os_release/**
No changes to PR templates, CODEOWNERS, .editorconfig, .gitattributes, or workflows
🗳️ Decision Request
Please choose Option A or Option B (or share constraints to refine).
👉 Vote in the poll
If Option A: I’ll open a small PR adding xtask/cargo-make and one CI job calling those tasks.
If Option B: I’ll keep the minimal pre-commit setup (typos + ShellCheck) with conservative excludes and no CI/workflow/template changes.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Context
In PR #1313, we explored adding docs/tooling configs (
markdownlint,dprint,lychee,typos).@GideonBear asked for a narrower scope—avoiding content churn (e.g., locales and OS-release)—and preferred
pre-commit/pre-commit-ciover GitHub Actions for docs/lint.The PR was closed with a request to realign. This RFC proposes two concrete approaches and asks maintainers to choose.
Goals and Constraints
rustfmtas the single source of truthcargo-first (single entrypoint, fast, reproducible)Orchestrate checks via
cargo(xtaskorcargo-make):fmt(rustfmt),clippy,cargo-denytypos(spelling),lychee(links),dprint(Markdown)ShellCheckCI: One job calls the same
cargotasks;lycheealso runs on a weekly schedule.Conservative excludes for translations and OS-release files to prevent false positives.
Why: Single toolchain, Rust-native CLIs are fast, cross-platform, reproducible, and caching is straightforward.
pre-commit-first, minimal scope)rustfmt/clippyfor Rustpre-commit/pre-commit-cifortyposandShellCheckmarkdownlint/dprintunless explicitly requested.typos.tomlwith excludes forlocales/**andsrc/steps/os/os_release/**CODEOWNERS,.editorconfig,.gitattributes, or workflows🗳️ Decision Request
Please choose Option A or Option B (or share constraints to refine).
👉 Vote in the poll
If Option A: I’ll open a small PR adding
xtask/cargo-makeand one CI job calling those tasks.If Option B: I’ll keep the minimal
pre-commitsetup (typos+ShellCheck) with conservative excludes and no CI/workflow/template changes.Beta Was this translation helpful? Give feedback.
All reactions