Skip to content

Commit 8c3ac76

Browse files
committed
contribution guideline
1 parent 9393d61 commit 8c3ac76

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,36 @@
11
# 贡献指南
22

3-
欢迎您对Lean-zh项目的兴趣!我们鼓励社区成员参与进来,一起帮助改善我们的项目。以下是参与贡献的几种方式:
4-
5-
## 报告问题
6-
7-
发现了问题或有任何建议,请通过GitHub Issues告诉我们。请确保你的问题尚未被报告过,同时提供足够的信息以便我们能够重现这一问题或理解您的建议。
3+
欢迎您对 Lean-zh 项目的兴趣!我们鼓励社区成员参与进来,一起帮助改善我们的项目。以下是参与贡献的几种方式:
84

95
## 文档翻译与校对
106

117
我们始终需要帮助将文档从英文翻译成中文,或对现有的中文文档进行校对。如果你希望帮助翻译或校对,请:
128

13-
1. 查看当前的文档,找到你感兴趣的部分。
14-
2. 在GitHub上对相应文件进行fork和编辑。
15-
3. 提交pull request,等待审查。
9+
1. 查看当前的文档列表,找到你感兴趣的部分
10+
2. 认领哪章就开个对应章名的 issue
11+
3. 在 GitHub 上对相应文件进行 fork 和编辑。
12+
4. 提交 pull request,等待审查。
13+
14+
Ref: [翻译规范](https://github.com/Agda-zh/PLFA-zh/issues/1)
1615

1716
## 撰写教程或改进代码
1817

1918
除了翻译和校对,我们也欢迎你撰写教程、提供示例或对项目的代码进行改进。无论是添加新功能,还是优化现有功能,我们都非常欢迎。
2019

20+
## 报告问题
21+
22+
发现了问题或有任何建议,请通过 GitHub Issues 告诉我们。请确保你的问题尚未被报告过,同时提供足够的信息以便我们能够重现这一问题或理解您的建议。
23+
2124
## 如何提交贡献
2225

2326
1. Fork 仓库并创建你的分支从 `main`
2427
2. 如果你修改了代码,请确保测试通过。
2528
3. 确保你的代码符合项目的风格指南。
26-
4. 提交pull request。
29+
4. 提交 pull request。
2730

2831
## 任何贡献都是有价值的
2932

30-
无论是改进文档、修复bug还是添加新功能,我们都非常感谢你的贡献!如果你是第一次贡献,也不用担心,我们是一个旨在提供一个开放、包容、学习的环境的社区。
33+
无论是改进文档、修复 bug 还是添加新功能,我们都非常感谢你的贡献!如果你是第一次贡献,也不用担心,我们是一个旨在提供一个开放、包容、学习的环境的社区。
3134

3235
## 问问题
3336

profile/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
欢迎来到 Lean-zh 的 GitHub 页面!这里是 Lean 定理证明器的中文翻译和文档项目。我们的目标是促进 Lean 在中文学术和编程社区的理解和应用。
44

55
## 项目目标
6-
- **翻译和校对**:提供 Lean 定理证明器官方文档的高质量中文翻译。
7-
- **社区互助**:建立一个支持和协作的社区环境,帮助中文用户学习和使用 Lean。
6+
- **翻译和校对**:提供 Lean 定理证明器官方文档的高质量中文翻译,参考[翻译规范](https://github.com/orgs/Lean-zh/projects/2)
87
- **资源共享**:分享有关 Lean 使用和学习的中文资源,包括教程、视频和案例研究。
98

109
## 如何参与

0 commit comments

Comments
 (0)