Skip to content

docs(readme): add --locked flag to cargo install command#1373

Merged
Timi16 merged 1 commit into
Timi16:mainfrom
israelolrunfemi:docs/add-locked-flag-to-cargo-install
Jun 1, 2026
Merged

docs(readme): add --locked flag to cargo install command#1373
Timi16 merged 1 commit into
Timi16:mainfrom
israelolrunfemi:docs/add-locked-flag-to-cargo-install

Conversation

@israelolrunfemi

Copy link
Copy Markdown
Contributor

Closes: #922

The quick-start installation command in README.md used cargo install
without the --locked flag. This means users could silently receive a
build with different transitive dependency versions than those tested and
shipped by the maintainers, leading to hard-to-reproduce bugs or install
failures between releases.

Changes made:

  • Add --locked to every cargo install invocation in README.md
  • Add a brief inline note explaining what the flag does and why it matters
  • Apply the same flag fix to any adjacent docs (getting-started.md,
    installation.md, CONTRIBUTING.md) where the same pattern appeared

No prose was rewritten. No Rust source files, Cargo.toml, or CI
configuration were modified. This is a documentation-only change.

Backlog: I-010

@drips-wave

drips-wave Bot commented May 31, 2026

Copy link
Copy Markdown

@israelolrunfemi Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@Timi16 Timi16 merged commit 9a1740b into Timi16:main Jun 1, 2026
6 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README quick-start installs via Cargo but doesn't mention the --locked flag, which is recommended for reproducible installs

2 participants