Skip to content

feat: 添加 markdown 语法及格式检查,添加 autoreview 工作流#265

Merged
TonyCrane merged 22 commits into
ZJU-Turing:masterfrom
TonyCrane:master
Aug 22, 2025
Merged

feat: 添加 markdown 语法及格式检查,添加 autoreview 工作流#265
TonyCrane merged 22 commits into
ZJU-Turing:masterfrom
TonyCrane:master

Conversation

@TonyCrane
Copy link
Copy Markdown
Member

@TonyCrane TonyCrane commented Aug 21, 2025

  • 使用 autocorrect 进行中英文混排的格式检查,一定程度上补充了 tools/punctuation_checker.py 的功能(仍有一部分规则 autocorrect 无法检测,无法完全替代)
  • 使用 markdownlint 进行 markdown 语法检查
  • 本 PR 中已使用这两工具对现有文档进行了格式修复
  • 添加了 autoreview workflow,利用 ReviewDog 来将检测结果自动上传到 code review 结果
  • 将原有的 punctuation checker 去掉被 autocorrect 覆盖的部分,并接入 ReviewDog

目前剩余:

  • 转为使用 ReviewDog
  • 将原有 checker 中被覆盖的部分规则删去,并接入 ReviewDog
  • 添加本地检测指南
  • 检查现有自动修改是否会导致渲染问题

@TonyCrane TonyCrane changed the title feat: 添加 markdown 语法及拼写检查,以及 autofix workflow feat: 添加 markdown 语法及拼写检查,以及 autoreview workflow Aug 22, 2025
@ZJU-Turing ZJU-Turing deleted a comment from github-actions Bot Aug 22, 2025
@TonyCrane TonyCrane marked this pull request as ready for review August 22, 2025 17:06
@TonyCrane TonyCrane requested a review from Copilot August 22, 2025 17:08
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds markdown syntax and spelling checks using autocorrect and markdownlint tools, introduces an autoreview workflow with ReviewDog integration, and applies formatting fixes to existing documentation.

  • Adds autocorrect tool for Chinese-English mixed text formatting checks and markdownlint for markdown syntax validation
  • Implements autoreview workflow using ReviewDog to automatically upload check results to code reviews
  • Refactors existing punctuation checker to remove rules covered by autocorrect and integrates it with ReviewDog

Reviewed Changes

Copilot reviewed 67 out of 83 changed files in this pull request and generated 1 comment.

File Description
tools/punctuation_checker.py Refactored to remove rules covered by autocorrect, simplified output format for ReviewDog integration, and removed GitHub URL/ref dependencies
Multiple .md files Applied formatting fixes including list marker standardization (asterisks to dashes), URL bracket corrections, spacing adjustments, and spelling corrections

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread tools/punctuation_checker.py
@TonyCrane TonyCrane changed the title feat: 添加 markdown 语法及拼写检查,以及 autoreview workflow feat: 添加 markdown 语法及格式检查,添加 autoreview 工作流 Aug 22, 2025
@TonyCrane TonyCrane merged commit 8f09349 into ZJU-Turing:master Aug 22, 2025
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants