Skip to content

贡献项目

Bestony edited this page Mar 25, 2017 · 1 revision

本页是关于如何对本项目进行贡献的说明页面。欢迎你!贡献者!

话题

  • 提交 Issue
  • PR 代码

提交 Issue

如果你想要为项目做出贡献,提交一个详细的 Issue 是最好的选择。我们非常欢迎认真的 Issue ,也非常感谢提出 Issue 的你。

检查我们的 Issues ,查看是否已经有了相关的 Issue 。如果你找到一个同类型的 Issue ,你可以点击 subscribe 来订阅这个 Issue ,当这个 Issue 有更新后,你会收到邮件提醒。

不要随机的进行 +1 或者回复 我也出现了同样的问题,他们对于问题的解决并没有任何的帮助。如果你有自己的办法来解决这个问题,希望你可以留下你自己的办法,来帮助更多的人解决问题。

如果你要提交 Issue,我们希望其中包含如下内容:

  • 您的手机的型号、操作系统的版本,如 Nexus 6 Android 6.0.1iPhone 6s Plus iOS 10.2.1
  • 您的微信的版本,如 微信 6.5.5
  • 您的场景数目(不是具体信息),如3个场景
  • 您出现问题的截图。如果您无法将图片上传到 github ,可以使用 sm.ms 提供的图床,将生成的 markdown 地址粘贴在回复框中。

PR代码

这里给出关于贡献代码的说明。

欢迎 Pull Request 代码

不知道那个错字是否值的拉取?发现一个问题,并且你知道如何解决他? Just Do It ! 我们会非常感激你的贡献。

但是要记得,在开始任何工作之前,应该先通过 Issue 来标记他!

当我们看到 Pull Request 时,我们会尽最大的努力,尽快处理它。

设计方案

你可以提交新的设计方案,或旧有功能的改进。当然,你也可以设计一个全新的特性!

Commit信息

commit 信息应该用大写的英文和简短的摘要开头,如果可以的话,最好有详细的解释性的文本来说明代码的更新内容。摘要和详细内容以空格隔开。

commit 信息应该遵循最佳实践,包括解释问题的上下文和解决办法,包括注意事项或必要的变更。

如果你不明白上面都说了啥,不妨先看看 How to Write a Git Commit Message