Skip to content

Goal 0: Developer Environment #260

Open
1 of 4 issues completed
Open

Description

@winstonliu1111

Experience: A contributor sets up, checks and tests a change on their own computer with one command for each step, and gets the same result as CI.

Acceptance criteria

  • In a fresh clone, just setup and then just gate pass. Evidence: gate output in the PR, and results from testers on macOS and Linux (WSL) (#G0-1).
  • The pip setup (requirements-dev.txt) keeps working until the maintainers decide to remove it. Evidence: the existing workflows pass unchanged, and git diff main -- .github requirements-dev.txt setup.cfg is empty (#G0-1).
  • A contributor can run a CI workflow in Docker with just act <workflow>. Evidence: the table of tested workflows in doc/DEVELOPMENT.md (#G0-1).
  • Tool versions are pinned and locked in uv.lock. A tool bump is one reviewed PR. Evidence: uv sync --locked output, lock file on main (#G0-2).
  • CI runs the same just recipes as the contributor, and the job names do not change. Evidence: workflow files, and a PR check list with the same names as before (#G0-3).
  • The old pip dev path is removed after the retirement checklist is complete. Evidence: the closed checklist (#G0-4).

Depends on: Goal 1 for #237 (et_replay) and #254 (linter). Both change pyproject.toml and requirements-dev.txt, so the lock file waits for them. Goal 4 owns the required checks (#243) and the format check in CI (#242). Goal 0 reuses them and does not repeat them.

  • The new tools sit next to the old ones. Nobody has to use uv on day one.
  • Each sub-issue is one PR. Each PR can be reverted alone.
  • just gate runs on the contributor's computer. It does not replace the CI checks. It does not build or test the C++ feeder.
  • Not in this goal: more ruff rules, stricter pyright, coverage, a Python 3.12 and 3.13 CI matrix, C++ sanitizers, and the src.* imports that force python -m pytest. The new tools make these safe to start later.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions