From 6692599c6c2fb21035fdd87d555c12cf0acdb29f Mon Sep 17 00:00:00 2001 From: Yu-Ting Hsiung Date: Sat, 31 May 2025 22:41:41 +0800 Subject: [PATCH 1/2] docs(contributing): add Contributing TL;DR page --- docs/contributing_tldr.md | 28 ++++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 29 insertions(+) create mode 100644 docs/contributing_tldr.md diff --git a/docs/contributing_tldr.md b/docs/contributing_tldr.md new file mode 100644 index 000000000..278fa520a --- /dev/null +++ b/docs/contributing_tldr.md @@ -0,0 +1,28 @@ +Feel free to send a PR to update this file if you find anything useful. 🙇 + +## Environment + +- Python `>=3.9` +- [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer) `>=2.0.0` + +## Useful commands + +Please check the [pyproject.toml](https://github.com/commitizen-tools/commitizen/blob/master/pyproject.toml) for a comprehensive list of commands. + +```bash +# Ensure you have the correct dependencies +poetry install + +# Make ruff happy +poetry format + +# Check if ruff and mypy are happy +poetry lint + +# Check if mypy is happy in python 3.9 +mypy --python-version 3.9 + +# Run tests in parallel. +pytest -n auto # This may take a while. +pytest -n auto +``` diff --git a/mkdocs.yml b/mkdocs.yml index 7b1e0feb3..dec8d3fd5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -58,6 +58,7 @@ nav: - Exit Codes: "exit_codes.md" - Third-Party Commitizen Templates: "third-party-commitizen.md" - Contributing: "contributing.md" + - Contributing TL;DR: "contributing_tldr.md" - Resources: "external_links.md" markdown_extensions: From f2748461706c8af79e3d4796d092420e367f37df Mon Sep 17 00:00:00 2001 From: Yu-Ting Hsiung Date: Sun, 1 Jun 2025 14:26:31 +0800 Subject: [PATCH 2/2] docs(contributing-tldr): add documentation changes section --- docs/contributing_tldr.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/contributing_tldr.md b/docs/contributing_tldr.md index 278fa520a..f5483cddc 100644 --- a/docs/contributing_tldr.md +++ b/docs/contributing_tldr.md @@ -9,6 +9,8 @@ Feel free to send a PR to update this file if you find anything useful. 🙇 Please check the [pyproject.toml](https://github.com/commitizen-tools/commitizen/blob/master/pyproject.toml) for a comprehensive list of commands. +### Code Changes + ```bash # Ensure you have the correct dependencies poetry install @@ -26,3 +28,10 @@ mypy --python-version 3.9 pytest -n auto # This may take a while. pytest -n auto ``` + +### Documentation Changes + +```bash +# Build the documentation locally and check for broken links +poetry doc +```