Skip to content

Commit 68bfbe6

Browse files
committed
docs: Update contributing guidelines
1 parent c8ed644 commit 68bfbe6

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,16 +48,17 @@ The first time you run `hatch shell` the environment will be created and activat
4848
>
4949
> This will make hatch set up its environments within the current working directory under `.venv`.
5050
51-
Alternatively, if you prefer to manage your virtual environments differently, you can install the package for development using, for example:
51+
Alternatively, if you prefer to manage your virtual environments yourself, you can install the package for development using, for example:
5252
5353
```sh
5454
python -m venv .venv
55+
source ./.venv/bin/activate
5556
pip install -e '.[dev,test,docs]'
5657
```
5758
5859
For all pull requests, linting and unit tests are automatically run using the [GitHub Actions](https://docs.github.com/en/actions) Continuous Integration service. However, you are still encouraged to run these checks locally before pushing code to a PR.
5960
60-
## Linting and formatting
61+
## Linting and Formatting
6162
6263
We use [ruff](https://docs.astral.sh/ruff/) for style checking. Run `ruff check .` or:
6364
@@ -71,11 +72,7 @@ Ruff can fix a lot of errors itself. Run `ruff check --fix .` or:
7172
hatch run fix
7273
```
7374
74-
Ruff includes a formatter that mimics [black](https://black.readthedocs.io/en/stable/). To automatically reformat your code, you can use `ruff format .` or:
75-
76-
```sh
77-
hatch run format
78-
```
75+
Ruff includes a formatter that mimics [black](https://black.readthedocs.io/en/stable/). To automatically reformat your code, you can use `ruff format {source_file}`.
7976
8077
We use [pre-commit](https://github.com/pre-commit/pre-commit) to make sure the coding style is enforced. You first need to install pre-commit and the corresponding git commit hooks:
8178

0 commit comments

Comments
 (0)