Skip to content

docs(contributing): add poetry and lychee tips #1745

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bearomorphism wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −0
Open

docs(contributing): add poetry and lychee tips #1745

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/contributing_tldr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ Please check the [pyproject.toml](https://github.com/commitizen-tools/commitizen
### Code Changes

```bash
# Make sure you have the latest version of poetry installed
poetry self update
Comment on lines +15 to +16
Copy link
Member

@noirbizarre noirbizarre Dec 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This really depends on how poetry is installed. It will not work with system installation, mise or asdf based installation...
So not sure we should include this instruction.
However, instead of forcing an update which might not be required, saying that "we require poetry>=X.Y.Z, you can verify with poetry --version" might be a better option

Copy link
Member

@woile woile Dec 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed


# Ensure you have the correct dependencies, for nix user's see below
poetry install

Expand All @@ -36,6 +39,13 @@ pytest -n auto <test_suite>
poetry doc
```

Also, we use [Lychee](https://lychee.cli.rs/) to check for broken links in the documentation.

```bash
# Check for broken links in the documentation
lychee .
```
Comment on lines +42 to +47
Copy link
Member

@noirbizarre noirbizarre Dec 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is a TLDR, broken link checking, with a tool not installed with the other dependencies but run on CI, may not be worth adding there. Breaking links while contributing is rare enough to just let it fail on CI if it happends, WDYT ?

Copy link
Member

@woile woile Dec 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed, also it's not nice to drop this responsibility on other. I think is better the PR runs, reports and someone can take action if they want


### Nix Users

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