-
-
Notifications
You must be signed in to change notification settings - Fork 477
Update Tutorials and How-to contributing pages #2522
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
| ``` | ||
|
|
||
| 5. Project requirements are defined in pyproject.toml. Libraries used for development and documentation are provided as optional dependency groups. To set up a development environment, you may (probably in a [virtual environment](https://docs.python-guide.org/dev/virtualenvs/)) run: | ||
| 5. We use [tox](https://tox.wiki/en/latest/index.html) to help with common development tasks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about the recommendation to first create a virtual environment? Not sure if this is mandatory, but I've found it helpful.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you mean to install tox in a dedicated virtual environment? It is a python library but I see it partially as pixi or conda too. It will create the different virtualenvs for each task. It could be different projects using tox might need different tox versions to work but I am not sure how worth is keeping the advice given the current workflow.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you mean to install tox in a dedicated virtual environment?
Yes, but in this exact time I'm also realizing it may not be needed. I've been doing it because I've been following this to literally.
So, let's continue without the virtual environment creation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should have those be links to the updated contributing guide at some point
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree
|
Everything looks great, only leaving small comments |
Co-authored-by: Tomás Capretto <[email protected]>
Review and update contributing pages after the refactor.