Skip to content

Commit 857b95f

Browse files
committed
docs: 贡献指南
1 parent b9f5edd commit 857b95f

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,22 @@
2020
- 网站页面设计
2121
- 在各种媒体、博客文章、群内宣传 HDU-CS-WIKI
2222

23+
## 文档风格
24+
1. 使用 Markdown 编写文档,文档格式参考 [Markdown 语法]()
25+
2. 一个页面只有一个1级标题(H1,一个#),其他标题从2级开始(H2,##)。
26+
3. 英文与中文之间用空格分开。
27+
```markdown
28+
AI 与人工智能,AGI 的发展方向。
29+
```
30+
4. 标题内的英文单词首字母大写。
31+
5. 代码块使用 ` ``` ` 包裹,并标注常见的语言标识符,如 ` ```python `
32+
33+
## 项目配置指南
34+
35+
修改新添加或移动位置的 md 文件需要在 `.vitepress/config.js` 中的 `sidebar` 中添加或修改对应的配置。
36+
37+
详见 [VitePress 官方文档](https://vitepress.dev/reference/default-theme-sidebar)
38+
2339
## 如何使用 Git 和 Github
2440

2541
详见 [3.5 Git和Github](https://hdu-cs.wiki/3.%E7%BC%96%E7%A8%8B%E6%80%9D%E7%BB%B4%E4%BD%93%E7%B3%BB%E6%9E%84%E5%BB%BA/3.5git%E4%B8%8Egithub.html)
@@ -59,4 +75,5 @@ subject为commit概述
5975
```
6076

6177
## Pull Request 流程与指南
62-
Fork 本仓库,然后在你的仓库中进行修改,修改完成后在本仓库创建 NEW Pull Request ,选择 compare across forks 提交 pr 并评论上你修改的具体信息即可,我们会第一时间审阅并合并。
78+
Fork 本仓库,然后在你的仓库中进行修改,修改完成后在本仓库创建 NEW Pull Request ,选择 compare across forks 提交 pr 并评论上你修改的具体信息即可,我们会第一时间审阅并合并。
79+

0 commit comments

Comments
 (0)