From 85fb3434a3f76f32e626b9f3f3145de80860d579 Mon Sep 17 00:00:00 2001
From: Yu-Ting Hsiung <bear890707@gmail.com>
Date: Mon, 29 Dec 2025 23:16:02 +0800
Subject: [PATCH] docs(contributing): add poetry and lychee tips

---
 docs/contributing_tldr.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/docs/contributing_tldr.md b/docs/contributing_tldr.md
index b7c1c9476..21e347e8f 100644
--- a/docs/contributing_tldr.md
+++ b/docs/contributing_tldr.md
@@ -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
+
 # Ensure you have the correct dependencies, for nix user's see below
 poetry install
 
@@ -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 .
+```
+
 ### Nix Users
 
 If you are using Nix, you can install poetry locally by running: