贡献指南 | Contributing Guide⚓︎
-
Pull request(适合源代码工作者)
-
问卷提交(适合大多数人)
-
联系作者(适合问卷无法描述的内容,更灵活,适用于作者不忙的情况)
如何编辑高级写法⚓︎
看这里:How to write
Pull request⚓︎
推荐会 pr 的同学使用这种方法,方便快捷,有多端 bot 检查语法,自动化,工作效率高 通过 pr 参与编辑的 GitHub 用户可以加入到
官方文档的贡献者
中,成为源代码仓库编辑的一员注意:直接参与源代码编辑你需要Markdown语法、少量HTML语法的基础知识
什么是 Markdown?答:Markdown 教程
学习 Markdown 语法并不需要很长时间,一旦你知道如何使用它,你就可以在几乎所有地方使用----Markdown 官方文档
什么是 HTML?答:HTML 教程
但如果你很想通过 Pull Request 来直接参与编辑,又不了解 Markdown、HTML 的语法,请联系项目作者,我很乐意与他人技术交流,即使是很简单的问题
如果你只需要修改局部内容,比如一句话,几段字,几行代码,请往下看。
如果你想提交大量内容,比如两个及以上文件有改动,或是提交新文件新页面,请先复刻本项目,克隆到你本地,修改完成后上传,然后再提交 Pull Request,既然你已经决定要提交多个文件改动,相信你也熟悉 Pull Request 操作,不需要此类教程,如果需要,请联系我本人,这里不在过多描述,相信你一定可以让项目更加完善
注意:请不要提交与本项目无关的 Pull Request,否则会被关闭
操作方法:在每一页可以编辑的页面右上角都有一个铅笔头
的编辑图标,点击图标即可跳转到编辑页面(由于是 GitHub 仓库页面,可能需要你进行一些操作保证页面的稳定访问)
1.fork 仓库⚓︎
点击图标之后,登录你的 Github 账号,如果你从未参与过编辑,你会看到如下页面
点击绿色的按钮 fork 到你的仓库之后,开始编辑
2.编辑源代码⚓︎
编辑完成之后,点击右上方的绿色按钮保存
3.提交⚓︎
填写你改动了什么,然后点击右下角的绿色按钮提交
出现下面这个页面就代表 Pull Request 成功,下面可能会有部署机器人的评论,不需要你管,等待源代码仓库拥有者合并就可以。
问卷提交 | Questionnaire Submission⚓︎
联系作者 | Contact the Author⚓︎
发现错误? 想参与编辑? 请阅读: 贡献指南,想联系作者?请点击: 联系作者,想赞助我? 请点击: 赞助计划