如何作出贡献

可以通过多种方法向群文档作出贡献，取决于你有多么积极。

不太积极——直接使用群文档

这没关系，仅仅使用群文档，让我们知道写这些东西有用有人看也足够了。
毕竟有很多人压根不看，只会在群里提问。

积极——Issues 提出建议

如认为群文档需要作出修改，请在群内向管理员提出建议，或发 Issues。修改包括但不限于：

  • 群文档存在错误
  • 群文档存在过时内容
  • 群文档有所缺漏

由于管理们时常不看大群 (别问为什么)，临时会话（QQ 功能，相当于不用加好友的私聊）和 Issues 也许是更好的方式。
建议有 GitHub 账号的群成员优先使用 Issues。

如何使用 Issues 功能

  • 登录你的 GitHub 账号。
  • 前往 Issues 创建页面。
  • 详细清晰地描述群文档哪里需要作出修改。务必指明哪一篇文档的哪一块内容需要做出修改。
  • 点文本框下面的绿色按钮以创建一个 Issue。

更加积极——Pull Requests 作出修改

如果你想亲自动手修改，那再好不过了。但请注意，修改时请遵守群文档编辑指南。

如何使用 Pull Requests 功能

Fork

如果你已经进行过这步了，可以跳过。

  • 点击 Fork，Owner 选择自己的账号，Copy the DEFAULT branch only 打勾。
  • 点击 Create fork。你的账号下将多出一个名为 groupdocs 的仓库。

编辑

  • 如果你之前参与过修改，请先将两仓库同步。转到你账号下的 groupdocs 仓库主页面，点击页面上方的 Sync fork，然后点击 Update branch。(如果你刚刚进行过 Fork，可以跳过这步。)
  • 在此仓库内进行编辑。

Pull Requests

  • 所有修改完成后，转到你账号下的 groupdocs 仓库主页面下。
  • 点击页面上方的 Contribute，然后点击 Open a pull request。
  • 填入标题和说明内容，说明内容可选。
  • 点击 Create pull request。Collaborators 会收到邮件通知，但鉴于可能不看邮箱，也请在 QQ 群内告知管理员。
  • 等待该 Pull Request 被 Merge。

给你和我省事

  • 务必在编辑前同步仓库。
  • 对于我明显已经命名过的文件，不要修改其名称。
    尤其是对于被引用的图片。不要老是改图片名称！如果你想更新这些图片，请把你更新后的图片改成我这里用的名称后再上传。

非常积极——Collaborators 直接修改

无须 Pull Requests 对群文档直接修改的权限，目前仅对管理员开放。原因包括但不限于：

  • GitHub 的 Collaborators 权限是整库修改权限，不可细化
  • 群文档难维护但容易破坏，可修复但难度较大（至少对负责维护的 Git 菜鸡们来说）

如果这打消了你的积极性，十分抱歉。但我们不能冒这个险，至少我不能接受。

参考

本文并未涉及 Git 操作。如果你使用 Git，请阅读下方的参考文档。

如果你看不懂 (尤其是 Pull Requests 那段)，很有可能不是你的问题，而是我没写清楚。在此情况下，请阅读下方的参考文档。

链接为 GitHub 中文文档。将链接中 github.com/ 后的 zh 改为 en 可阅读英文文档。

看懂了务必回来帮忙改改这篇（逃

results matching ""

    No results matching ""