跳转至

捐助

MkDocs的材料是一个积极维护和不断发展的项目 为具有多样化背景和需求的多样化用户群提供服务。为了 高效地满足所有用户的需求,评估变更请求, 为了修复bug,我们做了很多工作。

我们不断增长的社区包括许多活跃用户,他们打开新的 每天多次进行问题和讨论,改进我们的[问题跟踪器]和 [讨论板]变成一个知识库——一个重要的补充 我们的[文档]——为新用户和有经验的用户带来价值。

如何做出贡献

我们了解报告错误、提出变更请求以及参与 在讨论中可能很耗时,这就是为什么我们仔细优化了我们的 发布模板和定义的指导方针,以改善整体交互 在项目中。我们投入了大量的时间和精力来制作我们的 [问题跟踪器]和[讨论板]尽可能高效。

我们的目标是确保我们的文档以及问题跟踪器和 讨论板结构良好,易于导航 __可搜索,因此您可以快速有效地找到所需内容。因此, 当你遵循我们的指导方针时,我们可以更快地帮助你。

在本节中,我们将指导您完成我们的流程。

创建问题

  •   Something is not working?


    通过创建问题来报告MkDocs材料中的错误 繁殖


    Report a bug

  •   Missing information in our docs?


    报告我们网站中缺失的信息或潜在的不一致之处 文档


    Report a docs issue

  •   想提交一个想法吗?


    提出更改、功能请求或改进建议


    Request a change

  •   有问题或需要帮助?


    在我们的[讨论板]上提问,并与我们的 社区


    Ask a question

捐助

  •   缺少对您语言的支持?


    添加或改进新语言或已支持语言的翻译


    Add translations

  •   想要创建pull请求吗?


    学习如何创建全面且有用的拉取请求(PR)


    Create a pull request

清单

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

问题、讨论和评论是永恒的

请注意,您所写的一切都是永久性的,并将继续存在 让每个人都能阅读——永远。因此,请始终保持友善 建设性的,遵循我们的贡献准则,并遵守我们的 [行为准则]。

在创建问题之前

  • 您是否使用了适当的问题模板,或者是否存在其他问题 更适合您请求上下文的模板?

  • 您是否检查过是否已经有类似的错误报告或更改请求 创建,还是你偶然发现了一些可能相关的东西?

  • 你是否按照要求填写了每个字段,并提供了所有额外的 我们维护人员需要哪些信息来理解您的请求?

在提问之前

  • 该主题是我们[讨论板]的问题,还是错误报告或 更改请求最好在我们的[问题跟踪器]上提出?

  • 是否就您的请求主题进行了公开讨论?如果答案是肯定的, 你的问题是否符合讨论的方向,或者你应该打开一个 新讨论?

  • 您是否为我们的社区提供了所有必要的信息 理解你的问题并快速帮助你,或者你能让它更容易 帮你?

评论之前

  • 您的评论是否与当前页面、帖子、问题或 讨论,还是创建一个新问题或讨论是更好的主意?

  • 你的评论是否为对话增添了价值?它是否具有建设性和 尊重我们的社区和我们的维护者?你能用个 [:octicons-smiley-16:反应][反应]?

权利和责任

作为维护者,我们有责任进行调解 我们社区内的沟通,包括关闭、删除、, 拒绝或编辑问题、讨论、评论、提交,并阻止以下用户 __不符合我们的贡献准则和[行为准则]。 这一角色要求我们积极参与维护诚信和 我们社区的积极氛围。坚决维护这些标准 确保为所有成员提供一个尊重和包容的环境。

行为准则

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

我们严肃对待任何违规行为,并将采取适当行动应对 坚持这些价值观。1.

不完整的问题和重复

我们投入了大量的时间和精力来建立我们的贡献 流程,确保我们评估审查和 有效应对问题。我们问题模板中的每个字段都是 精心设计,帮助我们充分了解您的担忧和性质 关于你的事情。我们鼓励所有成员在之前使用搜索功能 提交新问题或开始讨论,以帮助避免重复。你的 合作对于保持我们社区的讨论具有建设性和 有组织的。

  • 强制填写问题模板: 我们需要所有的信息 在我们的问题模板中是必需的,因为它确保了每个用户和 维护人员,无论他们的经验如何,都能理解内容和 错误报告或更改请求的严重性。

  • 关闭未完成的问题: 我们保留解决缺乏基本信息的问题的权利,例如 包括但不限于[最小复制品]或不符合 我们的问题模板中规定的质量标准和要求。这样的 一旦提供了缺失的信息,就可以重新打开问题。

  • 处理重复项: 保持有序和高效 在我们的[问题跟踪器]和[讨论板]内进行沟通,我们 _保留关闭任何重复问题或锁定重复问题的权利 讨论。打开多个渠道问同一个问题或报告 不同论坛上的同一问题阻碍了我们管理和解决问题的能力 社区有效关注。这种方法对于高效时间至关重要 管理,因为重复的问题会占用多个团队的时间 成员同时。确保每个问题或讨论都是独一无二的 新信息的进展有助于我们保持专注并支持我们的 社区。

    我们进一步重申有权立即结束以下讨论或问题 在没有提供新信息的情况下重新打开,或者仅仅是因为用户 尚未收到对其问题/疑问的答复,因为该问题标记为 不完整。

  • 自动化工具的局限性: 虽然我们相信价值和 自动化工具在识别潜在问题(如 如Lighthouse、Accessibility工具和其他工具所标识的),简单 提交这些工具生成的问题并不构成完整 错误报告。这些工具有时会产生冗长的输出,可能包括 假阳性,这需要进行严格的评估。你当然是 欢迎将生成的报告附加到您的问题中。然而,这并不 用最少的复制或彻底的讨论代替要求 调查结果。_我们保留将这些问题标记为不完整和 关闭它们。_这种做法确保我们正在解决真正的问题 精确而清晰,而不是通过广泛的自动化导航 输出。


  1. 警告和阻止策略: 鉴于我们的项目越来越受欢迎,我们致力于 健康社区,我们已经就如何进行制定了明确的指导方针 违规行为:

    1.1. 第一次警告: 用户反复显示不恰当、冒犯性、, 或者有害行为将收到第一次警告。此警告用作 正式通知他们的行为与我们的社区不一致 标准和行为准则。第一个警告是永久性的。

    1.2. 第二次警告和解决机会: 如果行为 如果持续存在,将发出第二次警告。收到第二个 警告,用户将有5天的时间进行反思,在此期间 鼓励他们公开解释或为自己的行为道歉。 这一时期旨在提供一个机会,公开清除任何 误解。

    1.3. 舞台调度: 行为是否应该没有反应或改善 在第二次警告之后,我们保留阻止用户的权利 社区和存储库。封锁被认为是最后的手段,使用 只有在绝对必要的情况下才能保护社区的完整性和 积极的气氛。

    在我们的绝大多数地区,封锁是一种极其罕见的必要条件 积极的社区,突出我们对建设性对话的偏好 以及相互尊重。它旨在保护我们的社区成员和团队。