Skip to content

Commit 77b3451

Browse files
committed
Added info for local development.
Signed-off-by: Pavel Kirilin <[email protected]>
1 parent 8fb9f51 commit 77b3451

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,41 @@ pip install git+https://github.com/taskiq-python/taskiq
2323
```
2424

2525
You can read more about how to use it in our docs: https://taskiq-python.github.io/.
26+
27+
28+
# Local development
29+
30+
31+
## Linting
32+
33+
We use pre-commit to do linting locally.
34+
35+
After cloning this project, please install [pre-commit](https://pre-commit.com/#install). It helps fix files before committing changes.
36+
37+
```bash
38+
pre-commit install
39+
```
40+
41+
42+
## Testing
43+
44+
Pytest can run without any additional actions or options.
45+
46+
```bash
47+
pytest
48+
```
49+
50+
## Docs
51+
52+
To run docs locally, you need to install [yarn](https://yarnpkg.com/getting-started/install).
53+
54+
First, you need to install dependencies.
55+
```
56+
yarn install
57+
```
58+
59+
After that you can set up a docs server by running:
60+
61+
```
62+
yarn docs:dev
63+
```

0 commit comments

Comments
 (0)