blob: 6e27d5659f6b2555a534ce19fb3f5badd139ea82 (
plain)
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
# Contributing to Rich
This project welcomes contributions in the form of Pull Requests.
For clear bug-fixes / typos etc. just submit a PR.
For new features or if there is any doubt in how to fix a bug, you might want
to open an issue prior to starting work, or email willmcgugan+rich@gmail.com
to discuss it first.
## Development Environment
Rich uses [poetry](https://python-poetry.org/docs/) for packaging and
dependency management. To start developing with Rich, install Poetry
using the [recommended method](https://python-poetry.org/docs/#installation) or run:
```
pip install poetry
```
Once Poetry is installed, install the dependencies with the following command:
```
poetry install
```
### Tests
Run tests with the following command:
```
make test
```
Or if you don't have `make`, run the following:
```
pytest --cov-report term-missing --cov=rich tests/ -vv
```
New code should ideally have tests and not break existing tests.
### Type Checking
Rich uses type annotations throughout, and `mypy` to do the checking.
Run the following to type check Rich:
```
make typecheck
```
Or if you don't have `make`:
```
mypy -p rich --ignore-missing-imports --warn-unreachable
```
Please add type annotations for all new code.
### Code Formatting
Rich uses [`black`](https://github.com/psf/black) for code formatting.
I recommend setting up black in your editor to format on save.
To run black from the command line, use `make format-check` to check your formatting,
and use `make format` to format and write to the files.
|
