From f8d135559bae8c7971da0b3576e417efe05c7c58 Mon Sep 17 00:00:00 2001 From: Koudai Aono Date: Wed, 31 Dec 2025 18:51:09 +0000 Subject: [PATCH 1/3] Add pre-commit hook setup instructions to contributing guide --- docs/development-contributing.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/development-contributing.md b/docs/development-contributing.md index 9ce8b3d9b..cf445ef4c 100644 --- a/docs/development-contributing.md +++ b/docs/development-contributing.md @@ -29,22 +29,25 @@ $ tox run -e dev .tox/dev is a Python environment you can use for development purposes -## 5. Create new branch and rewrite code. +## 5. Install pre-commit hooks +$ .tox/dev/bin/prek install + +## 6. Create new branch and rewrite code. $ git checkout -b new-branch -## 6. Run unittest under Python 3.13 (you should pass all test and coverage should be 100%) +## 7. Run unittest under Python 3.13 (you should pass all test and coverage should be 100%) $ tox run -e 3.13 -## 7. Format and lint code (will print errors that cannot be automatically fixed) +## 8. Format and lint code (will print errors that cannot be automatically fixed) $ tox run -e fix -## 8. Check README help text is up to date +## 9. Check README help text is up to date $ tox run -e readme -## 9. Check CLI documentation is up to date +## 10. Check CLI documentation is up to date $ tox run -e cli-docs -## 10. Commit and Push... +## 11. Commit and Push... ``` ## ➕ Adding a New CLI Option From 173942745ea25b7476a1e683bb64908d8cf15607 Mon Sep 17 00:00:00 2001 From: Koudai Aono Date: Wed, 31 Dec 2025 18:59:05 +0000 Subject: [PATCH 2/3] Use uv tool install prek instead of .tox path --- docs/development-contributing.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/development-contributing.md b/docs/development-contributing.md index cf445ef4c..cf2ca6947 100644 --- a/docs/development-contributing.md +++ b/docs/development-contributing.md @@ -30,7 +30,8 @@ $ tox run -e dev .tox/dev is a Python environment you can use for development purposes ## 5. Install pre-commit hooks -$ .tox/dev/bin/prek install +$ uv tool install prek +$ prek install ## 6. Create new branch and rewrite code. $ git checkout -b new-branch From 6f438f2cd19d501ae308cbf36544be9f59222945 Mon Sep 17 00:00:00 2001 From: Koudai Aono Date: Wed, 31 Dec 2025 19:01:29 +0000 Subject: [PATCH 3/3] Add config-types instruction to CLI option guide --- docs/development-contributing.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/development-contributing.md b/docs/development-contributing.md index cf2ca6947..9628676e9 100644 --- a/docs/development-contributing.md +++ b/docs/development-contributing.md @@ -115,6 +115,9 @@ $ python scripts/build_cli_docs.py # Verify docs are correct $ tox run -e cli-docs + +# If you modified config.py, regenerate config TypedDicts +$ tox run -e config-types ``` ### 🔧 Troubleshooting