docs(doc): 更新 README 自检说明与 git-submit 流程
This commit is contained in:
@@ -19,9 +19,13 @@ description: 执行 Git 提交和推送工作流
|
|||||||
- 误把生成物/大文件加入:先移除或补 `.gitignore`
|
- 误把生成物/大文件加入:先移除或补 `.gitignore`
|
||||||
- 变更跨度过大:提醒用户是否需要拆分提交
|
- 变更跨度过大:提醒用户是否需要拆分提交
|
||||||
|
|
||||||
### 2)起草提交信息(中文;这是唯一一次需要用户确认的环节)
|
### 2)起草提交信息(中文;默认不需要用户确认)
|
||||||
|
|
||||||
根据对话历史和修改的文件信息,按下方规范先给出“建议的提交信息”,然后询问用户:**“是否确认/需要修改?”**
|
根据对话历史和修改的文件信息,按下方规范直接生成提交信息并继续执行后续流程。
|
||||||
|
|
||||||
|
- 如果用户已经明确给出提交信息,直接使用用户提供的版本
|
||||||
|
- 如果用户没有指定提交信息,按下方规范自动生成最合适的一条
|
||||||
|
- **不要**为了 commit message 再额外等待用户确认,除非用户明确要求先看 message 再提交
|
||||||
|
|
||||||
#### Git Commit Message 规范
|
#### Git Commit Message 规范
|
||||||
|
|
||||||
@@ -88,4 +92,4 @@ refactor(irgen): 简化 AST → IR 构建流程
|
|||||||
|
|
||||||
- 暂存所有改动:`git add -A`
|
- 暂存所有改动:`git add -A`
|
||||||
- 单行摘要:`git commit -m "<type>(<scope>): <subject>"`,需要补充说明时用多行:`git commit -m "<summary>" -m "<detail 1>" -m "<detail 2>"`
|
- 单行摘要:`git commit -m "<type>(<scope>): <subject>"`,需要补充说明时用多行:`git commit -m "<summary>" -m "<detail 1>" -m "<detail 2>"`
|
||||||
- 推送:`git push`,推送完成后立即停止,不要再运行其他命令
|
- 推送:`git push`,推送完成后立即停止,不要再运行其他命令
|
||||||
|
|||||||
@@ -88,10 +88,10 @@ cmake --build build -j "$(nproc)"
|
|||||||
./build/bin/compiler --help
|
./build/bin/compiler --help
|
||||||
```
|
```
|
||||||
|
|
||||||
(可选)生成 IR 并验证 LLVM 工具链是否可用:
|
跑完整编译流程自检:从 SysY 源码生成 AArch64 汇编,完成汇编、链接,并在 QEMU 下运行结果程序:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./scripts/verify_ir_with_llvm.sh test/test_case/simple_add.sy out/ir --run
|
./scripts/verify_asm_with_qemu.sh test/test_case/simple_add.sy out/asm --run
|
||||||
```
|
```
|
||||||
|
|
||||||
兼容说明:`scripts/gen_ir.sh` 仍可使用,但作为兼容入口会转调 `verify_ir_with_llvm.sh`。
|
如果最终看到 `退出码: 3`,说明当前最小子集示例 `return a + b` 的完整链路已经跑通。
|
||||||
Reference in New Issue
Block a user