Skip to content

Improve dev onboarding and docs #160

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
May 7, 2025
Merged

Improve dev onboarding and docs #160

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4b674ca
add more details around installing on virtualenv or conda environments
fpliger Apr 30, 2025
198a7c8
add instructions to run the pyscript command in dev
fpliger Apr 30, 2025
ac14832
add section about how to create a new release
fpliger Apr 30, 2025
32b979c
add section about how the release process works
fpliger Apr 30, 2025
da49eab
fix mispellings (enviroment and avaible)
fpliger May 6, 2025
70de351
pin the python version when creating the dev environment
fpliger May 6, 2025
9e50f53
add note on how to build the package whell locally
fpliger May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix mispellings (enviroment and avaible)
  • Loading branch information
@fpliger
fpliger committed May 6, 2025
commit da49eab417c946b771d30df588ba54bedf64ad05
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ git clone https://github.com/pyscript/pyscript.git
pip install --upgrade pip
```

Create a local enviroment with your enviroment manager of choice.
Create a local environment with your environment manager of choice.

### Virtualenv

Expand All @@ -36,7 +36,7 @@ conda activate pyscript-cli

### Installation

Now that you have your environment set up and activated, install your local enviroment dependencies
Now that you have your environment set up and activated, install your local environment dependencies

```shell
pip install -e ".[dev]"
Expand All @@ -48,15 +48,15 @@ It is now possible to normally use the CLI. For more information on how to use i

## Run the tests

After setting up your developer enviroment, you can run the tests with the following command from the root directory:
After setting up your developer environment, you can run the tests with the following command from the root directory:

```shell
pytest .
```

# Running CLI Commands

Once the installation process is done, the `pyscript` CLI is avaible to be used once the environment has been
Once the installation process is done, the `pyscript` CLI is available to be used once the environment has been
activated. Simply run `pyscript` with the appropriate command. For instance, to see the list of commands:

```shell
Expand Down