diff --git a/docs/dev_guides/code_contributing_path_cn.md b/docs/dev_guides/code_contributing_path_cn.md index 8acb38521ee..56a71666cba 100644 --- a/docs/dev_guides/code_contributing_path_cn.md +++ b/docs/dev_guides/code_contributing_path_cn.md @@ -148,19 +148,32 @@ nothing added to commit but untracked files present (use "git add" to track) ➜ git add test.md ``` -每次 `git commit` 都需要写提交说明，方便其他人了解每次提交做了哪些改变，可以通过 `git commit -m "add a new file test.md"` 完成。 +每次 `git commit` 都需要写提交说明，方便其他人了解每次提交做了哪些改变，可以通过 `git commit -m ` 完成。 ```bash ➜ git commit -m "add a new file test.md" -CRLF end-lines remover...............................(no files to check)Skipped -yapf.................................................(no files to check)Skipped -Check for added large files..............................................Passed -Check for merge conflicts................................................Passed -Check for broken symlinks................................................Passed -Detect Private Key...................................(no files to check)Skipped -Fix End of Files.....................................(no files to check)Skipped -clang-formater.......................................(no files to check)Skipped -[my-cool-stuff c703c041] add test.md file +check for added large files..............................................Passed +check for merge conflicts................................................Passed +check for broken symlinks............................(no files to check)Skipped +detect private key.......................................................Passed +fix end of files.........................................................Passed +sort simple yaml files...............................(no files to check)Skipped +trim trailing whitespace.................................................Passed +CRLF end-lines remover...................................................Passed +Tabs remover (C++)...................................(no files to check)Skipped +Tabs remover (Python)....................................................Passed +copyright_checker........................................................Passed +black....................................................................Passed +flake8...................................................................Passed +ruff.....................................................................Passed +clang-format.........................................(no files to check)Skipped +cpplint..............................................(no files to check)Skipped +clang-tidy...........................................(no files to check)Skipped +auto-generate-cmakelists.............................(no files to check)Skipped +cmake-format.........................................(no files to check)Skipped +CMake Lint...........................................(no files to check)Skipped +sort-txt-file........................................(no files to check)Skipped +[my-cool-stuff e309f4805e] add a new file test.md 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 233 ``` diff --git a/docs/dev_guides/docs_contributing_guides_cn.md b/docs/dev_guides/docs_contributing_guides_cn.md index fb9afc25c78..e267e6486e4 100644 --- a/docs/dev_guides/docs_contributing_guides_cn.md +++ b/docs/dev_guides/docs_contributing_guides_cn.md @@ -107,49 +107,29 @@ no changes added to commit (use "git add" and/or "git commit -a") ``` 恢复后重新进行修改并提交文件即可。 -- pre-commit：提交修改说明前，需要对本次修改做一些格式化检查： - -``` -➜ pre-commit -CRLF end-lines remover...............................(no files to check)Skipped -yapf.....................................................................Passed -Check for added large files..............................................Passed -Check for merge conflicts................................................Passed -Check for broken symlinks................................................Passed -Detect Private Key...................................(no files to check)Skipped -Fix End of Files.........................................................Passed -clang-format.........................................(no files to check)Skipped -cpplint..............................................(no files to check)Skipped -pylint...................................................................Passed -copyright_checker........................................................Passed -``` - 全部 Passed 或 Skipped 后，即可进入下一步。如果有 Failed 文件，则需要按照规范，修改出现 Failed 的文件后，重新 `git add` -> `pre-commit`，直至没有 Failed 文件。 -``` -➜ pre-commit -CRLF end-lines remover...............................(no files to check)Skipped -yapf.....................................................................Failed -- hook id: yapf -- files were modified by this hook -Check for added large files..............................................Passed -Check for merge conflicts................................................Passed -Check for broken symlinks................................................Passed -Detect Private Key...................................(no files to check)Skipped -Fix End of Files.........................................................Passed -clang-format.........................................(no files to check)Skipped -cpplint..............................................(no files to check)Skipped -pylint...................................................................Failed -- hook id: pylint-doc-string -- exit code: 127 - -./tools/codestyle/pylint_pre_commit.hook: line 11: pylint: command not found - -copyright_checker........................................................Passed -``` -- 填写提交说明：Git 每次提交代码，都需要写提交说明，让其他人知道这次提交做了哪些改变，可以通过 ``git commit`` 完成： +- commit ：提交本地更改 -``` +每次 `git commit` 都需要写提交说明，方便其他人了解每次提交做了哪些改变，可以通过 `git commit -m ` 完成。 + +```bash ➜ git commit -m "fix docs bugs" -``` +check for merge conflicts................................................Passed +check for broken symlinks............................(no files to check)Skipped +detect private key.......................................................Passed +fix end of files.........................................................Passed +trim trailing whitespace.................................................Passed +CRLF end-lines remover...................................................Passed +Tabs remover.............................................................Passed +CN-[whitespace]-EN fixer.................................................Passed +convert jinja2 into html.............................(no files to check)Skipped +convert-markdown-into-html...........................(no files to check)Skipped +black................................................(no files to check)Skipped +ruff.................................................(no files to check)Skipped +[my-cool-stuff ee8f4441f] fix docs bugs + 1 file changed, 19 insertions(+), 34 deletions(-) +``` + +> 注意：`git commit` 执行后会进行代码预检测，不能出现失败的情况，如果有 failed 的检测项需先处理，才能继续后续步骤。 ### 3.2 确保本地仓库是最新的