Skip to content

docs: add uv.lock best practices guide#7

Open
agent-kurouto[bot] wants to merge 1 commit intodevfrom
eywalker/plt-1028-add-uvlock-best-practices-guide-to-nauticalabpython-best
Open

docs: add uv.lock best practices guide#7
agent-kurouto[bot] wants to merge 1 commit intodevfrom
eywalker/plt-1028-add-uvlock-best-practices-guide-to-nauticalabpython-best

Conversation

@agent-kurouto
Copy link
Contributor

@agent-kurouto agent-kurouto bot commented Mar 19, 2026

Summary

  • Adds docs/uv-lock.md — a concise best practices guide for uv.lock targeting Python developers transitioning from pip/poetry to uv
  • Updates README.md contents table to include the new guide

Guide covers

  • What uv.lock is and how it relates to pyproject.toml
  • Why lock files matter (reproducible builds, deterministic installs)
  • When to commit uv.lock (applications: always; libraries: usually not)
  • uv lock vs uv sync — distinct roles and when to run each
  • Comparison with pip-tools requirements.txt and poetry.lock
  • Updating dependencies (uv lock --upgrade, --upgrade-package, uv add/uv remove)
  • CI/CD considerations (uv sync --frozen, uv lock --check, caching .venv)

Test plan

  • Render docs/uv-lock.md in GitHub and verify formatting, links, and code blocks display correctly
  • Confirm README.md table links to the new guide correctly

Closes PLT-1028

🤖 Generated with Claude Code

Adds docs/uv-lock.md covering what uv.lock is, why lock files matter,
when to commit (applications vs libraries), uv lock vs uv sync, comparison
with pip-tools and poetry, dependency update workflows, and CI/CD usage
with --frozen and uv lock --check. Updates README contents table.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

0 participants