Update CONTRIBUTING.md and dependencies after packaging modernization#2162
Merged
pydanny merged 7 commits intocookiecutter:mainfrom Aug 30, 2025
Merged
Update CONTRIBUTING.md and dependencies after packaging modernization#2162pydanny merged 7 commits intocookiecutter:mainfrom
pydanny merged 7 commits intocookiecutter:mainfrom
Conversation
Justfile use Uv to run commands.
- pick sphinx-autodoc from docs/requirements.txt to pyproject.toml - create servedocs command un justfile - update CONTRIBUTING
Since bf173de Modernize packaging and CI/CD workflow (cookiecutter#2157) tox have been removed from project dependencies and Uv is used instead
pydanny
approved these changes
Aug 30, 2025
Member
pydanny
left a comment
There was a problem hiding this comment.
Thank you so much for submitting this PR, this really helps.
How would you feel about a follow-up PR that converts the project from using pip in the contributing file to uv? 😄 No worries if that's too much, just thought you might want to get that in. 😄
Contributor
Author
|
Hi @pydanny, thanks for approval.
I am not confortable with |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hello
Since this commit that remove Tox from the project and introduce Just as task runner for replace make, some sections of
CONTRIBUTING.mdare outdated. Also, the commands provided by the contributing are no longer working.This PR propose to
servedocsandcoveragethat are mentioned inCONTRIBUTING.mdtojustfileuvtodevgroup dependencies because it is needed by just tasksCONTRIBUTING.md, at "check that your changes pass the tests and lint check" stepCONTRIBUTING.mdsphinx-autobuilddependency fromdocs/requirements.txttodocsdependencies group inpyproject.tomlPlease note that this PR adds two dev dependencies to
pyprojet.toml,uvthat are needed byjustfileandsphinx-autobuildthat are needed byjust servedocs.I'm not sure it's still necessary to keep the
sphinx-autobuilddependency indocs/requirements.txtbecause it’s now only used in.readthedocs.yaml.With this PR, setup the project and run tests/lint should work out of the box by executing commands listed in
CONTRIBUTING.md.