Skip to content

Commit

Permalink
docs: add more instructions for the developers.
Browse files Browse the repository at this point in the history
  • Loading branch information
fky2015 committed Sep 4, 2022
1 parent f15faeb commit 20444a3
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# 开发者指南

## 任务管理

我们采用 [Github Projects](https://github.com/BITNP/BIThesis/projects) 进行任务管理。
你可以每次选择其中的一个小的 TODO 进行开发;来帮助项目一点一点前进。

## 开发命令

Makefile 主要针对 Linux 和 MacOS 开发者;如果你使用 Windows 开发,可能需要手动执行 Makefile 中具体的命令。

当然,也欢迎你贡献更通用的开发脚本。

### 生成 `.cls` 文件

```Bash
Expand All @@ -21,13 +32,17 @@ make doc
make dev
```

### 单元测试和回归测试
## 参考资料

TODO

## 单元测试和回归测试

运行 `make test` 将对所有的模板进行编译测试(同样被用于 Github Action)。

运行 `make regression-test` 进行回归测试,该命令将比较目前已发布的最新版本和本地版本生成的 PDF 的差异。
使用前请确保 `diff-pdf``zsh` 已经安装。

### Release 工作流
## Release 工作流

![Release Workflow](./assets/release_workflow.png)

0 comments on commit 20444a3

Please sign in to comment.