What the developer wrote
Authored by Tobin C. Harding
Revert "CI: Add formatting job"
This reverts commit cf39b4013bcf661ceae3327da91c4da4d0898f9d.
As usual `rustfmt` is fucking us in the arse.
What changed, and why it matters
This commit simply removes an automated code-formatting check from the project's continuous integration (CI) pipeline and deletes the related contributor guidance. It does not change any library code, cryptographic logic, or network behavior, and it introduces no security vulnerability.
No security action required. This is a project workflow/policy change. Teams that want enforced formatting may choose to reintroduce the CI job later, but that is a code-quality preference, not a security decision.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch reverts a prior CI addition that ran cargo fmt --check on pull requests. It removes the fmt --check entry from the GitHub Actions workflow matrix and strips the formatting note from CONTRIBUTING.md. No Rust source files are modified, no dependencies are changed, and no runtime code paths are affected.
Changed components
.github/workflows/rust.ymlCONTRIBUTING.mdInspect captured patch +1 / −14
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
index 62af540a..c699c4b4 100644
--- a/.github/workflows/rust.yml
+++ b/.github/workflows/rust.yml
@@ -36,7 +36,7 @@ jobs:
strategy:
fail-fast: false
matrix:
- task: [api, lint, docs, docsrs, bench, "fmt --check"]
+ task: [api, lint, docs, docsrs, bench]
steps:
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ae77b731..97f6ad43 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -190,19 +190,6 @@ adhere to the ideas presented in the following two blog posts:
- [How to Write a Git Commit Message](https://cbea.ms/git-commit/)
- [Write Better Commits, Build Better Projects](https://github.blog/2022-06-30-write-better-commits-build-better-projects/)
-Note on formatting:
-
-- We attempt to keep the codebase formatted but it is not a merge pre-requisite.
-- `master` may not format cleanly, if so please throw a formatting patch at the
- front of your PR if you plan on formatting your changes. I.e., don't include
- arbitrary formatting changes in your other patches.
-- You can use `just fmt`.
-- Remember to use nightly if your editor runs the formatter (`cargo +nightly fmt`).
-- There is a CI job that runs the formatter.
-- There is a _very_ long history on the reasons for all this. Sorry this is the
- best solution we have been able to come up with to keep all parties somewhat
- happy.
-
### Deprecation and Versioning
Whenever any part of your code wants to mention the version number the code will
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.