贡献¶

Material for MkDocs 是一个积极维护和不断发展的项目，服务于具有多样背景和需求的用户群体。为了有效满足所有用户的需求，评估变更请求并修复错误，我们投入了大量的工作。

我们不断壮大的社区包括许多活跃用户，他们每天都会多次提出新问题和讨论，使我们的 issue tracker 和 discussion board 发展成为一个知识库——这是我们 documentation 的一个重要补充，为新用户和经验丰富的用户都带来了价值。

如何贡献¶

我们理解，报告错误、提出变更请求以及参与讨论可能会耗费时间，这就是为什么我们仔细优化了我们的 issue 模板并定义了指导方针，以改善项目内的整体互动。我们在使我们的 issue tracker 和 discussion board 尽可能高效方面投入了大量时间和精力。

我们的目标是确保我们的文档、issue tracker 和讨论板是 结构良好、易于导航 和 可搜索 的，这样您就可以快速高效地找到所需内容。因此，当您遵循我们的指导方针时，我们可以更快地帮助您。

在本节中，我们将引导您了解我们的流程。

创建问题¶

贡献¶

检查清单¶

在参与项目之前，请花一点时间考虑以下问题。这样，您可以确保使用正确的 issue 模板，并在与我们的社区互动时提供所有必要的信息。

在创建问题之前¶

• 您是否使用了适当的 issue 模板，或者是否有其他更适合您请求上下文的 issue 模板？

• 您是否检查过是否已经创建了类似的错误报告或变更请求，或者您是否发现了可能相关的内容？

• 您是否按照要求填写了每个字段，并提供了我们维护者理解您请求所需的所有附加信息？

在提问之前¶

• 该主题是我们 discussion board 的问题，还是应该在我们的 issue tracker 上提出的错误报告或变更请求？

• 关于您请求的主题是否有开放的讨论？如果答案是肯定的，您的问题是否与讨论的方向相符，或者您是否应该开启一个新的讨论？

• 您是否向我们的社区提供了所有必要的信息，以便理解您的问题并快速帮助您，或者您是否可以让问题更易于理解？

在评论之前¶

• 您的评论是否与当前页面、帖子、问题或讨论的主题相关，或者创建一个新的问题或讨论是否更好？

• 您的评论是否为对话增添了价值？它是否对我们的社区和我们维护者具有建设性和尊重？您是否可以仅使用 反应？

权利与责任¶

作为维护者，我们被赋予了 责任 来调节我们社区内的沟通，包括关闭、删除、拒绝或编辑问题、讨论、评论、提交的权利，以及阻止与我们的贡献指南和 [行为准则] 不一致 的用户。这个角色要求我们积极参与维护我们社区的完整性和积极氛围。坚守这些标准确保了所有成员的尊重和包容环境。

行为准则¶

我们的 [行为准则] 概述了所有社区成员应相互尊重的期望，使用包容和欢迎的语言。我们的承诺是营造一个积极和支持的环境，远离不当、冒犯或有害的行为。

我们对任何违规行为都非常重视，并将采取适当措施以维护这些价值观。¹

不完整的问题和重复问题¶

我们在建立我们的贡献流程方面投入了大量时间和精力，确保我们有效评估审查和响应问题的基本要求。我们 issue 模板中的每个字段都经过深思熟虑，旨在帮助我们充分理解您的关切和问题的性质。我们鼓励所有成员在提交新问题或开始讨论之前使用搜索功能，以帮助避免重复。您的合作对于保持我们社区讨论的建设性和有序至关重要。

• 强制填写问题模板： 我们需要您在 issue 模板中提供的所有信息，因为这确保了每个用户和维护者，无论其经验如何，都能理解您错误报告或变更请求的内容和严重性。

• 关闭不完整的问题： 我们 保留关闭缺乏必要信息的问题的权利，例如但不限于 [最小重现] 或未遵循我们 issue 模板中规定的质量标准和要求的问题。这些问题在提供缺失信息后可以重新打开。

• 处理重复问题： 为了维护我们 issue tracker 和 discussion board 内的有序和高效沟通，我们 保留关闭任何重复问题或锁定重复讨论的权利。在不同论坛中打开多个渠道以询问相同问题或报告相同问题会妨碍我们有效管理和解决社区关切。这种做法对于高效的时间管理至关重要，因为重复的问题可能会同时消耗多个团队成员的时间。确保每个问题或讨论都是独特的，并随着新信息的出现而进展，有助于我们保持专注并支持我们的社区。

  我们进一步 保留立即关闭未提供新信息的重新开启讨论或问题的权利，或仅仅因为用户尚未收到对其问题/问题的回应，因为该问题被标记为不完整。

• 自动化工具的局限性： 虽然我们相信自动化工具在识别潜在问题（例如 Lighthouse、无障碍工具等）方面的价值和效率，但仅仅提交这些工具生成的问题并不构成完整的错误报告。这些工具有时会产生冗长的输出，并可能包括误报，这需要进行批判性评估。您当然可以将生成的报告附加到您的问题中。然而，这并不能替代最小重现或对发现进行全面讨论的要求。我们保留将这些问题标记为不完整并关闭它们的权利。这种做法确保我们以精确和清晰的方式解决真正的关切，而不是在大量自动化输出中徘徊。