Skip to content

feat(tooling): add quality check workflow#50

Open
gac0812 wants to merge 2 commits into
1024XEngineer:mainfrom
gac0812:docs/project-setup-upstream
Open

feat(tooling): add quality check workflow#50
gac0812 wants to merge 2 commits into
1024XEngineer:mainfrom
gac0812:docs/project-setup-upstream

Conversation

@gac0812

@gac0812 gac0812 commented Jul 16, 2026

Copy link
Copy Markdown

Summary

  • document the monorepo layout and backend/mobile startup commands
  • add the repository quality-check script and Cursor hook workflow definitions
  • clarify that pre-commit blocks only failed checks

Dependencies

Issue

Fixes #51

This documentation and tooling should merge after the backend and mobile application changes are available.

@fennoai fennoai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review Summary

Found three documentation issues that make the advertised quality-check and hook workflows inaccurate or unusable. Details are inline.

View job run

Comment thread README.md
一键全量检查:

```bash
bash scripts/check-all.sh # 前后端全部

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

High: The documented scripts/check-all.sh entry point does not exist in this PR, main, or either declared dependency PR (#48/#49). After the documented merge order, every command in this block still fails with No such file or directory; add the script (and make it executable) or document the actual backend/frontend commands instead.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Fixed in gac0812@6a4b8c4. Added executable scripts/check-all.sh with all, backend, and frontend targets plus invalid-target validation. Verified bash -n scripts/check-all.sh and the complete quality-check run.

Comment thread README.md
## Git hooks(提交/推送拦截)

hooks 不预置在仓库中。git 仓库就绪后,在 Cursor 里对 AI 说「启用 git hooks」,AI 会按
`.cursor/skills/timeflow-git-hooks/SKILL.md` 中的模板把三个 hook 写入 `.git/hooks/` 并验证:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

High: This hook setup depends on .cursor/skills/timeflow-git-hooks/SKILL.md, but that file is absent from this PR and dependency PRs #48/#49; the development-standards skill referenced on line 33 is absent as well. Consequently the promised Cursor workflow cannot install or validate any hooks. Include the skill definitions in the merge set or remove these instructions.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Fixed in gac0812@6a4b8c4. Added the always-applied Cursor rule and both referenced skill definitions to this PR, including the hook installation and validation templates.

Comment thread README.md Outdated
hooks 不预置在仓库中。git 仓库就绪后,在 Cursor 里对 AI 说「启用 git hooks」,AI 会按
`.cursor/skills/timeflow-git-hooks/SKILL.md` 中的模板把三个 hook 写入 `.git/hooks/` 并验证:

- `pre-commit`:按改动范围跑对应端检查,不过不让提交

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Medium: 不过不让提交 says the pre-commit hook runs checks but does not allow commits at all, which contradicts the intended conditional gate. If the hook blocks only failing checks, this should say 不通过不让提交 (or otherwise describe the real condition).

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Fixed in gac0812@6a4b8c4. The README now states that pre-commit runs checks for the affected area and blocks the commit only when those checks fail.

@gac0812 gac0812 changed the title docs: add project setup instructions feat(tooling): add quality check workflow Jul 17, 2026
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.

Documented quality-check and hook workflow is unavailable

1 participant