Skip to content

Commit de4f3a8

Browse files
committed
docs(readme.md readme-zh.md): add a reminder
1 parent afa8adc commit de4f3a8

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

README-zh.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,13 @@
1212

1313
## 贡献
1414

15-
对于站内任何一部分,你若有想要增添/修正/删减等的内容,欢迎提出 [Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
15+
对于站内任何一部分,你若有想要增添/修正/删减等的内容,欢迎提出 [Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) ,在提交之前,请先自行运行
16+
17+
```bash
18+
mkdocs serve
19+
```
20+
21+
进行测试。
1622

1723
本仓库采用 [commitlint](https://github.com/conventional-changelog/commitlint) + [husky](https://github.com/typicode/husky) 的方案自动进行 `commit message` 的审查,请确保 `commit message` 符合 [Conventional Commits](https://www.conventionalcommits.org/zh-hans/v1.0.0/) 规范。但也不必过多担心,本仓库已集成 [Commitizen](https://github.com/commitizen/cz-cli) 协助填写 `commit message` 。具体包及版本见 [package.json](package.json) ,在首次 `commit` 前请使用
1824

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,13 @@ The site has automatic deployment in place, so there is no need to build static
1212

1313
## Contribution
1414

15-
If you have any content you want to add, correct, or delete on this site, you are welcome to submit a [Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
15+
If you have any content you want to add, correct, or delete on this site, you are welcome to submit a [Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork). Before committing, please run
16+
17+
```bash
18+
mkdocs serve
19+
```
20+
21+
to test it first.
1622

1723
This repository uses the [commitlint](https://github.com/conventional-changelog/commitlint) + [husky](https://github.com/typicode/husky) solution to automatically review `commit messages`. Please ensure that your `commit messages` conform to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. However, don't worry too much, as this repository has integrated [Commitizen](https://github.com/commitizen/cz-cli) to assist in writing `commit messages`. For specific packages and versions, see [package.json](package.json). Before first committing, please use
1824

0 commit comments

Comments
 (0)