如何参与贡献

首先，感谢您抽出时间对该项目做出贡献！

请注意，这里只会回答有关框架的问题。如果您想提有关信道的问题，请联系信道的作者或是在相应的代码仓库中提出疑问。

下面是一个简单的指南，介绍如何提交一个简洁明了的问题报告或是功能请求的请求。

If you need help, or want to talk to the authors, feel free to visit our GitHub Discussions forum, or chat with us at our Telegram support group.

在提出问题之前，请仔细阅读并尽可能的遵循这份指南。否则可能导致社区不友善的回应或是零回应，虽然我们会尽量避免这样做。

反馈 Bug

提交 bug 报告之前

• 请确保您的问题仅限于框架本身，而不针对某个特定的组件。有关组件的问题应前往组件的相关区域提问。

• 请先阅读文档，以查看您的问题是否已有解决方案。

• 检查 已报告的 Issue 列表以确保您的问题未被报告过。

如何提交一份（有用的）Bug 报告？

• 使用一个明确的和描述性的标题来描述问题。

• 尽可能地给出重现问题的详细确切步骤。

• 提供具体的示例及复现步骤。

• 描述你执行这些步骤后所观察到的现象，并指出这种现象所存在的问题。

• 解释一下你期望发生的现象及为原因。

• 若问题不是由某个特定操作引起的，请描述问题发生前你所进行的操作，并依据以下准则提交尽可能多的信息。

• 提供与该问题相关的日志。使用 verbose 模式启动日志记录过程，并提交从第一步操作开始的完整日志。

通过回答这些问题以提供更多的背景信息：

• 是否最近才出现问题（如更新到最新版本后），还是一直存在这个问题？

• 您能可靠地重现这个问题吗？如果不能，请提供详细信息，描述问题发生的大致频率和通常在何种情况下它会发生。

提供您的配置信息及操作环境：

• 您的 EFB 版本号是多少？ 您可以通过 --version 来获取版本号。

• 您的操作系统类型及版本号是多少？

注意

在您提交报告前，请确保您的个人信息已被全部抹去。

功能建议

如果您有任何疑问，请在 issue 中提交您的问题。请尽量提供您所掌握的信息，包括：

• 使用一个明确的和描述性的标题来描述您的建议。

• 详细说明新功能的行为。

• 提供具体的抽象化方式及示例。

• 对框架提出的提案必须适用于多数即时通讯平台，而不只是一个单一的平台。 针对某一平台的具体建议应在其相关信道提出。

  改编自 GitHub Inc 的 Atom contribution guide。

Pull requests

当您对程序做了些修改并想要提交给我们，请将该项目 fork 至您的账户并修改，并提交一份 pull request。请在您的 pull request 中详细描述以下内容：

• 您做了什么更改？

• 您解决了哪一个问题？

• 您涉及了哪一个 issue？（若适用）。

为所有 commit 撰写清楚的日志消息。对于简单的修改，可以接受简短的说明，但达到一定程度更改需要在正文进行详细的描述。

改编自 Participatory Politics Foundation 的 OpenGovernment contribution guide。