Skip to content

Commit

Permalink
Update contributing doc after using it
Browse files Browse the repository at this point in the history
  • Loading branch information
mfisher87 committed Apr 24, 2024
1 parent 17f5788 commit 9aebab7
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,22 @@ description of best practices for developing scientific packages.

[spc-dev-intro]: https://learn.scientific-python.org/development/

## Quick development
## Setting up a development environment manually

You can set up a development environment by running:

```bash
python3 -m venv .venv
source ./.venv/bin/activate
pip install -v --editable .[dev]
```

## Testing, linting, rendering docs with `nox`

The fastest way to start with development is to use nox. If you don't have nox,
you can use `pipx run nox` to run it without installing, or `pipx install nox`.
If you don't have pipx, then you can install with `pip install pipx`. If you use
macOS, use `brew install pipx nox`. To use:
The fastest way to start is to use nox. If you don't have nox, you can use
`pipx run nox` to run it without installing, or `pipx install nox`. If you don't
have pipx, then you can install with `pip install pipx`. If you use macOS, use
`brew install pipx nox`. To use:

```
nox
Expand All @@ -29,16 +39,6 @@ $ nox -s build # Make an SDist and wheel
Nox handles everything for you, including setting up an temporary virtual
environment for each run.

## Setting up a development environment manually

You can set up a development environment by running:

```bash
python3 -m venv .venv
source ./.venv/bin/activate
pip install -v -e .[dev]
```

## Automated pre-commit checks

`pre-commit` can check that code passes required checks before committing:
Expand Down

0 comments on commit 9aebab7

Please sign in to comment.