Skip to content
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

update venv instructions and first contribution guide #705

Merged
merged 2 commits into from
Apr 8, 2024
Merged

update venv instructions and first contribution guide #705

merged 2 commits into from
Apr 8, 2024

Conversation

davidism
Copy link
Contributor

@davidism davidism commented Apr 8, 2024

Clone repo first, then create .venv folder within the repo. Current instructions said to clone the repo into the venv folder, which is generally not a good idea. Use .venv name which VSCode and PyCharm tend to recognize better.

Rearranges the first time contribution section to explain a bit more about git, GitHub, and the virtualenv, and the proper order that parts happen in.

fixes #671
alternative to #698
(I started working on this at the PyCascades sprint before I noticed either of these.)

@davidism davidism requested a review from a team as a code owner April 8, 2024 17:56
@davidism davidism marked this pull request as draft April 8, 2024 18:02
@davidism davidism changed the title update venv instructions update venv instructions and first contribution guide Apr 8, 2024
@davidism davidism marked this pull request as ready for review April 8, 2024 18:43
@pathunstrom pathunstrom merged commit 2c3167d into ppb:canon Apr 8, 2024
22 checks passed
@davidism davidism deleted the contributing-venv branch April 8, 2024 19:04
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.

Update Getting Started
2 participants