参与文档建设
欢迎大家对本文档进行贡献。
包括且不限于
- 修正错误,补充代码。
- 添加更详细的描述。
- 增加新想法。
请您在撰稿或者修正以前,仔细阅读以下内容,以帮助您完成更高质量的内容。
需要了解一些 Markdown 的知识,请查看 Markdown。
我之前没怎么用过 GitHub
你也可以直接发文本给我,由我手动合并,但这样你并不会得到 contribute。
首先你需要有一个 GitHub 帐号,但不需要高超的 GitHub 技巧。
- 点击标题右边的编辑按钮,开始编辑。
- 在编辑框里进行修改。由于 MkDocs 支持一些扩展 Markdown,它不一定能在 GitHub 的预览里很好的展示。
- 写好了之后点下方的绿色按钮 Propose changes 提交修改。但是,GitHub 可能会提示你没有权限。不必担心!GitHub 会自动帮你将 本项目 的所有文件复制一份,放到你的仓库中(fork)并创建申请合并更改的请求 (Pull Request);
- 之后,点上方的绿色按钮 (Create pull request) 后,GitHub 会跳转到一个新的页面 Open a pull request。删掉方框里的文字,简单写写你做的修改,然后再点一下下面的绿色按钮 (Create pull request);
- 不出意外的话,你的 PR 就顺利提交到仓库,等待合并了。之后,你就可以等待项目组合并你的分支,或者指出还要修改的地方。当然,你也可以给他人的 PR 提出修改意见,或者只是点赞/踩。如果有消息,会有邮件通知和/或出现在网页右上角的提醒(取决于你个人 Settings 中的设置)。
在你的分支被合并 (merge) 到主分支 (main) 之前,你对 本项目 所做的任何修改都不会出现在页面上。所以请不用担心“你的编辑会破坏网页正在显示的页面”一事。
我之前用过 GitHub
大胆写吧!