Skip to content

chore: delete requirements.txt and document uv as the single install path#6

Merged
wiyth00 merged 2 commits into
mainfrom
chore/drop-requirements-txt
Jul 25, 2026
Merged

chore: delete requirements.txt and document uv as the single install path#6
wiyth00 merged 2 commits into
mainfrom
chore/drop-requirements-txt

Conversation

@wiyth00

@wiyth00 wiyth00 commented Jul 25, 2026

Copy link
Copy Markdown
Owner

Summary

requirements.txt contained a single line, -e .[dev]. That editable install directly contradicts the locked uv sync --all-extras --no-editable workflow used by CI and documented in CONTRIBUTING.md, and it gave contributors a second, silently divergent install path.

  • Delete requirements.txt
  • Add an Install section to CONTRIBUTING.md stating that uv + the committed uv.lock are the single source of truth, and noting why --no-editable matters when reproducing CI failures

Work plan item P2 / 9.

Scientific impact

None. No package code is touched; this is repository hygiene and documentation only.

  • No change to computed results
  • Results change (described above)

Checklist

  • ruff check . passes
  • pytest passes locally
  • New or changed behaviour is covered by a test (n/a — no behaviour change)
  • Docs / README updated if user-facing behaviour changed

Lint/test boxes left unchecked because this branch was pushed without a local run — CI on this PR is the first execution.

wiyth00 added 2 commits July 24, 2026 23:15
It contained `-e .[dev]`, an editable install that contradicts the locked
`uv sync --all-extras --no-editable` workflow used by CI and CONTRIBUTING.
Replaces the deleted requirements.txt with an explicit Install section.
@wiyth00
wiyth00 merged commit 65b0b72 into main Jul 25, 2026
1 check 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.

1 participant