docs: update README (#1098)

This commit is contained in:
Yineng Zhang
2024-08-14 19:40:05 +08:00
committed by GitHub
parent f14569f64a
commit fe5024325b
4 changed files with 13 additions and 5 deletions

View File

@@ -10,6 +10,7 @@ Briefly describe the changes made in this PR.
## Checklist
1. Ensure pre-commit `pre-commit run --all-files` or other linting tools are used to fix potential lint issues.
2. Confirm that modifications are covered by complete unit tests. If not, please add more unit tests for correctness.
3. Modify documentation as needed, such as docstrings or example tutorials.
-[] Before submitting a PR for review, make sure it has passed verification in your local development environment **at least**.
-[] Ensure pre-commit `pre-commit run --all-files` or other linting tools are used to fix potential lint issues.
-[] Confirm that modifications are covered by complete unit tests. If not, please add more unit tests for correctness.
-[] Modify documentation as needed, such as docstrings or example tutorials.