docs: record dependency decisions in DEPENDENCIES.md - #246
Open
BenjaminDEMAILLE wants to merge 1 commit into
Open
docs: record dependency decisions in DEPENDENCIES.md#246BenjaminDEMAILLE wants to merge 1 commit into
BenjaminDEMAILLE wants to merge 1 commit into
Conversation
CONTRIBUTING.md requires a new dependency to be raised in an issue before the PR, which covers the decision but not the record: the justifications lived in Cargo.toml comments and the rejections lived nowhere, so a crate turned down in August gets re-proposed in February and re-argued from scratch. Four sections: runtime dependencies, dev-only dependencies, considered and declined, and under evaluation. The fourth exists so that an open evaluation is not read as either an acceptance or a rejection, and so the next proposal lands on the existing thread. Licenses and versions come from `cargo metadata`, and every "used by" entry names a file that imports the crate; both were checked rather than recalled, which corrected four rows I had first written from memory. The Cargo.toml comments for the flate2 backend and mimalloc are trimmed to a summary plus a pointer, and CONTRIBUTING.md links the file next to the rule it serves. Closes #209.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #209.
CONTRIBUTING.mdrequires a new dependency to be raised in an issue before the PR. That covers the decision. The record was missing: justifications lived inCargo.tomlcomments, and rejections lived nowhere, so a crate turned down in August gets re-proposed in February and re-argued from scratch.Four sections rather than the three the issue proposed:
Checked, not recalled
Licenses and versions are the resolved ones from
cargo metadata. Every "used by" entry names a file that actually imports the crate, verified by grep, and a script confirmed every path in the file exists. That caught four rows I had written from memory:flate2is used bysolo/whitelist.rs,solo/count.rsandbin/emptydrops.rsrather than "quant/",rayonbyindex/sa_build.rsamong others,noodlesbybam_dedup.rsandwasp/mod.rs, andpredicatesby exactly one test.Also in this PR, per the issue's checklist
Cargo.tomlcomments for thezlib-rsbackend and formimallocare trimmed to a summary plus a pointer, so the long form lives in one place.CONTRIBUTING.mdlinks the file next to the rule it serves.Documentation only: no code changes, and
cargo buildand the parameter tests are green.🤖 Generated with Claude Code