致读者

如果你是我们的读者，希望通过 ReadMe 有所收获，请阅读接下来的网页使用指南——

一、文档阅读与下载

ReadMe 会分类展示稿件。我们的git仓库连接为https://github.com/ssast-readme/ssast-readme.github.io，你可以前往下载并进行二次创作。如果您觉得 ReadMe 对您有帮助，也可以在 GitHub 上给我们 Star。

二、文档反馈

如果你想对 ReadMe 的内容提出勘误，或者有相关意见，可以在文档下方的评论区中进行评论，或者在 GitHub 上提交 issue 和 pull request。

对每一位给予帮助的读者，我们将致以谢意，奖励包括但不限于志愿工时、荣誉称号、相关物资等。

互助文档使用说明

一、文档路径

• 课程笔记：/docs/note
• 作业攻略：/docs/homework
• 技术分享：/docs/tech
• 科创经验分享：/docs/innovation

二、文档下载

• PDF 文档：打开文件后，点击下图 Download 即可下载

• Markdown 文档：打开文件后，点击下图蓝色高亮图标即可复制全文内容

三、提交 issue

1.如何提交一个 issue？

• 选中下图中 issues 选项：
• 点击下图中右侧绿色按钮“New issue”，新建一个 issue
• 出现如下界面，在“title”处填写标题，在“leave a comment”处填写内容，最后点击右下角绿色按钮提交 issue 即可

2. Issue 提交规范

• Issue 列表以可读和可检索为目标。提交者有义务将标题总结的有意义和易于检索，并保持内容的正确和完整性；
• 请在经过充分的检索之后，确定无相关的已存在 Issue，再提交新的 Issue；
• Issue 类型划分为错误反馈、文档需求和问题，请在提交 Issue 时根据 Issue 类型填写标题，标题开头需加上【错误反馈】【文档需求】或【问题】；
• 鼓励读者就文档事实性错误提出反馈。科协将做好记录。

四、提交 Pull Request

1.如何提交一个 Pull Request？

可以参考如下链接： GitHub 的 Pull Request 是指什么意思？

• beepony 的回答 - 知乎 https://www.zhihu.com/question/21682976/answer/79489643

2. Pull Request 提交规范

• 一个 PR 只围绕一件事情
  • 如果确有必要将几件事情（例如修改特别小、相互之间有依赖等）一起提交 PR，则需要列明具体每一件事情，确保 PR 说明涵盖了所有修改内容。
• PR 标题——概述此次 Pull Request 的目标
  • 例如：尝试用 XXX 方法实现……、优化……、修复在 XX 状态下对 XX 的异常处理。

ReadMe, 因你存在，为你存在。

本站总访问量次

评论