Source-build docs omit uv required by just fmt
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Domain
- build-system, documentation
Research direction
Read docs/install.md and the root justfile, especially the fmt recipe and its Python SDK commands. Update the source-build helper-tool guidance or its formatting-specific note so a fresh setup understands when uv is required. Done means the documented setup accurately covers running just fmt.
Written by the indexing model from the issue text.
Description
What happened?
docs/install.md tells contributors building from source to install Rust, just, and cargo-nextest, then recommends running the root justfile helpers such as just fmt.
However, the fmt recipe in the root justfile also runs Python SDK formatting through uv:
uv run --frozen --project ../sdk/python --extra dev ruff check --fix --fix-only ../sdk/python
uv run --frozen --project ../sdk/python --extra dev ruff format ../sdk/python
A fresh source-build setup following docs/install.md may therefore fail at just fmt unless uv is installed separately.
Expected behavior
The source-build docs should either include uv in the helper tool installation steps or clarify that uv is required only when running formatting checks that touch the Python SDK.
Additional context
I searched open issues and PRs for terms including uv, just fmt, and install docs, and did not find an existing open item that appears to cover this setup-doc omission.
- Dominant language
- Rust
- Stars
- 125k
- Forks
- 19.5k
- Avg merge
- 1m
- Merged PRs (30d)
- 1k
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from openai/codex
-
enhancement remote
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
bug CLI windows-os
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
macOS sandbox blocks hw.optional.arm64 sysctl, causing Flutter to misdetect Apple Silicon as x64 Openbug CLI sandbox
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bug CLI TUI
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
CLI config enhancement skills
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
gitbutlerapp/gitbutler#15998 · 1 comment ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
bitcoindevkit/bdk-ffi#1125 ·