Improve dev onboarding and docs #160
Merged
Conversation
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
CONTRIBUTING.md
Outdated
| ``` | ||
|
|
||
| Make a virtualenv and activate it: | ||
| Create a local enviroment with your enviroment manager of choice. |
There was a problem hiding this comment.
enviroment --> environment
CONTRIBUTING.md
Outdated
| In case you choose to use conda, use the following commands: | ||
|
|
||
| ```shell | ||
| conda create -n pyscript-cli python |
There was a problem hiding this comment.
can probably pin to a specific python version here
CONTRIBUTING.md
Outdated
|
|
||
| ### Installation | ||
|
|
||
| Now that you have your environment set up and activated, install your local enviroment dependencies |
There was a problem hiding this comment.
enviroment --> environment (the 2nd one)
There was a problem hiding this comment.
Seems like the typo is present in other parts of the README too, which are not touched in this PR
CONTRIBUTING.md
Outdated
|
|
||
| # Running CLI Commands | ||
|
|
||
| Once the installation process is done, the `pyscript` CLI is avaible to be used once the environment has been |
madhur-tandon
previously approved these changes
May 6, 2025
There was a problem hiding this comment.
We can probably add the following note:
if you wanna build locally using python -m build , also pass the env var CHECK_VERSION as False aka CHECK_VERSION=False python -m build
this will skip the check tag version stuff in setup.py
Approved but there are typos
|
Cool, TY! Will address the comments and re-commit. |
madhur-tandon
approved these changes
May 7, 2025
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.
We made changes switching the dev environment to just use setup.py to install the whole stack and also established a release workflow/action. This PR adds information on how both work and how to properly set up a dev environment and how to release a new version