为SubQuery项目贡献代码

2021-11-24 大约 2 分钟

# 为SubQuery项目贡献代码

非常欢迎并感谢您考虑为SubQuery项目贡献时间和精力编写项目代码! 让我们一起为更加去中心化的未来铺平道路。

此文档由SubQuery团队维护。 我们欢迎您为此做出贡献,您可以通过查看我们的GitHub项目并更改docs目录下的所有标记文件来实现这一点。

下面是一套促进SubQuery发展的准则(而不是规则)。 遵循这些指导方针将有助于我们使作出贡献的进程对每一个参与者都是容易和有效的。 它还通知您同意尊重开发者管理和开发此项目的时间。 作为回报,我们将通过解决你的问题、考虑变化、协作改进以及帮助你完成你的拉请求来对付这种尊重。

# 编程规约

我们认真对待我们开放源码社区的项目和责任,并要求我们和其他贡献者遵守高标准的通信。 通过参与和贡献这个项目,您同意维护我们的 行为准则 (opens new window)

# 快速入门

对我们的repositories贡献是通过解决问题和pull request(PRs) 进行。 一般来说,准则涵盖如下内容:

  • 在创建您自己之前先搜索现有的问题和PR。
  • 我们努力确保问题得到迅速处理,但这视该问题影响大小而定,可能需要一段时间才能调查根源。 如果您遇到问题,可以在评论帖子中友情@提及提交者或贡献者获得帮助。

# 如何参与贡献

# 提交 bug

错误被作为GitHub 问题跟踪。 当登录一个问题时,解释问题并包含更多细节来帮助维护者重现问题:

  • 使用一个明确的和描述性的标题\ 来描述问题。
  • 描述复制问题的确切步骤。
  • 描述跟随步骤之后您观察到的行为。
  • 解释一下你期望发生的现象及为原因。
  • 尽可能包括屏幕截图。

# 提交 Pull requests

一般情况下,我们按照"fork-and-pull" Github 工作方式

  • 将repository 分派到您自己的 Github 帐户
  • 复制项目到您的设备
  • 以简洁但描述性的名称创建本地分支
  • 提交对项目的更改
  • 遵循原repo 的格式和测试准则
  • 将更改推送到你的账户中
  • 在 repository中打开一个Pull requests。

# 代码约定

# 提交消息

  • 使用当前时态("去添加功能"而不是"添加过的功能")
  • 使用准确的代码时态("移动光标到..."而不是“移动光标到...")
  • 第一行限制为72个字符或更少字符

# JavaScript 样式表

  • 所有 JavaScript 代码都与Prettier 和 ESLint 同调
上次编辑于: 2021年11月24日 02:27