supervision icon indicating copy to clipboard operation
supervision copied to clipboard

fix: Align pyproject.toml with contribution guide

Open ArnabTechiee opened this issue 2 months ago • 1 comments

Description

This PR fixes a bug in the developer setup process where the installation command from the CONTRIBUTING.md guide would fail.

The failure was caused by a mismatch between the dependency group definitions in pyproject.toml and the --extra flags used in the guide's command. This change aligns the pyproject.toml file with the documentation by moving the dev and docs dependency groups to [project.optional-dependencies] and adds the missing pre-commit package to the dev group.

This ensures a smooth setup experience for new contributors.

Closes #1970

Type of change

  • [x] Bug fix (non-breaking change which fixes an issue)

How has this change been tested, please provide a testcase or example of how you tested the change?

I have tested the change by following the steps to reproduce the bug:

  1. Set up a clean virtual environment.
  2. Run the installation command from the contributing guide: uv pip install -r pyproject.toml --extra dev --extra docs --extra metrics.
  3. Verified that the command, which previously failed, now completes successfully and installs all dependencies.

Any specific deployment considerations

None.

Docs

  • [ ] Docs updated? What were the changes: N/A

ArnabTechiee avatar Oct 03 '25 15:10 ArnabTechiee

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Oct 03 '25 15:10 CLAassistant