File: CONTRIBUTING.md

package info (click to toggle)
python-sphinx-issues 5.0.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 148 kB
  • sloc: python: 551; sh: 17; makefile: 5
file content (25 lines) | stat: -rw-r--r-- 382 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# Contributing

## Setting up for development

- Create and activate a new virtual environment
- `pip install -e '.[dev]'`
- (Optional but recommended) Install the pre-commit hooks, which will
  format and lint your git staged files:

```
# The pre-commit CLI was installed above
pre-commit install
```

- To run tests:

```
pytest
```

- To run syntax checks:

```
tox -e lint
```