Skip to content

Commit 85fb343

Browse files
committed
docs(contributing): add poetry and lychee tips
1 parent cf03c8d commit 85fb343

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/contributing_tldr.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ Please check the [pyproject.toml](https://github.com/commitizen-tools/commitizen
1212
### Code Changes
1313

1414
```bash
15+
# Make sure you have the latest version of poetry installed
16+
poetry self update
17+
1518
# Ensure you have the correct dependencies, for nix user's see below
1619
poetry install
1720

@@ -36,6 +39,13 @@ pytest -n auto <test_suite>
3639
poetry doc
3740
```
3841

42+
Also, we use [Lychee](https://lychee.cli.rs/) to check for broken links in the documentation.
43+
44+
```bash
45+
# Check for broken links in the documentation
46+
lychee .
47+
```
48+
3949
### Nix Users
4050

4151
If you are using Nix, you can install poetry locally by running:

0 commit comments

Comments
 (0)