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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
# Contributing
We follow the [Jupyter Contribution Workflow](https://jupyter.readthedocs.io/en/latest/contributing/content-contributor.html) and the [IPython Contributing Guide](https://github.com/ipython/ipython/blob/master/CONTRIBUTING.md).
## Code formatting
Use the [pre-commit](https://pre-commit.com/) tool to format and lint the codebase:
```console
# to apply to only staged files
$ pre-commit run
# to run against all files
$ pre-commit run --all-files
# to install so that it is run before commits
$ pre-commit install
```
## Testing
Tests can be run through [`hatch`](https://hatch.pypa.io/) which will automatically manage test environments and dependencies.
```console
# to run all tests
$ hatch run test:test
# to run with coverage (used by CI)
$ hatch run cov:test
```
## Documentation
NbClient needs some PRs to copy over documentation!
## Releasing
If you are going to release a version of `nbclient` you should also be capable
of testing it and building the docs.
Please follow the instructions in [Testing](#testing) and [Documentation](#documentation) if
you are unfamiliar with how to do so.
The rest of the release process can be found in [these release instructions](./RELEASING.md).
|
