贡献指南
欢迎参与本项目!我们感谢所有对文档的改进,包括新增栏目、修正错误、优化表述或补充示例。 贡献前请阅读以下说明:
如何参与
1. 提交问题或建议
- 发现错别字、表述不清或内容缺失?请先检查现有 Issue 是否已提及。
- 新建 Issue 时说明:
- 问题类型(错误修正/内容补充/结构调整)
- 具体位置(文件路径或章节标题)
- 你的建议(附上正确内容或参考链接)
2. 直接提交修改
- Fork 本仓库到你的账户。
- 编辑文件:
- 小型修改(如错别字):可直接在 GitHub 网页端点击文件右上角 ✏️ 图标编辑。
- 大型调整:建议本地克隆后使用 Markdown 编辑器修改。
- 提交 PR:
- 标题示例:
fix: 修正刷铁机的术语错误
/docs: 新增铁路生电环线
- 描述中注明修改原因(可关联 Issue)。
- 标题示例:
文档规范
- 格式:使用项目约定的 Markdown 语法(如标题层级、代码块标识)。
- 语言:
- 中文文档请使用书面化表达,避免口语化。
- 技术术语保持中英文一致(如“JavaScript”不写作“JS”)。
- 配图:图片请放在
/assets/images/
目录,引用时使用相对路径。
注意事项
- 争议性内容修改建议先发起讨论。
- 大型结构调整请先在 Issue 中说明方案。