提议新内容或功能

我们始终乐于听取社区关于 MDN Web Docs 新内容或功能的建议。然而,尽管我们对建议持开放态度,但我们必须牢记以下几点:

  • MDN Web Docs 由一个小型内部团队运营和管理。我们也高度依赖我们的合作伙伴和社区,帮助我们将 MDN Web Docs 打造成 Web 上面向 Web 开发者的最佳资源。因此,我们有时不得不拒绝新的内容或功能,因为我们根本无法长期维护它们。
  • MDN Web Docs 也专注于记录开放 Web 标准;某些内容可能不适合。这并不意味着想法或内容不好,只是 MDN Web Docs 不是最适合它的地方。

牢记以上几点,如果您确实想为 MDN Web Docs 提议内容或功能,请遵循以下步骤。

开启内容建议和功能提议 issue

当您去开启一个 新的 issue 时,您会发现一个名为“新内容或功能建议”的模板。当建议新内容或功能时,这就是要使用的 issue 模板。这个 issue 模板确实需要很多信息,但这是非常深思熟虑的。

  1. 它确保我们拥有评审您的提议所需的所有信息,而无需大量来回沟通。
  2. 它在您填写表单时帮助您仔细思考您的提议。

填写完表单并提交 issue 后,核心团队成员将在大约一周到两周内回复您,具体取决于您提议的复杂程度。

参与讨论并等待批准

如果我们认为您的提议可能是一个不错的选择,我们将在我们的 MDN 社区讨论仓库中 开启一个讨论。这是为了听取我们合作伙伴和更广泛社区的意见。我们鼓励您关注讨论并酌情加入。

开启 issue

假设就我们是否要添加此内容或构建此功能达成共识。在这种情况下,我们将针对适当的仓库开启一个 issue,引用原始提议和讨论,并填补任何空白,使 issue 明确可操作。

分配工作

此时,工作将被优先排序并分配给负责确保其实现和评审的人员。

开启 Pull Request

一旦工作准备好评审,就应该开启一个 Pull Request,其中再次引用提议、讨论和 issue。这确保了我们始终拥有工作的完整上下文。最后,将分配所需人员,并开始评审流程。

评审并合并工作

同样,根据内容或功能的复杂程度,评审阶段可能会很长。我们请求您的耐心,并希望您继续酌情参与。一旦我们获得至少两名内部团队成员的批准,我们就可以合并 Pull Request 了。

这将结束整个流程,内容或功能将在 MDN Web Docs 上可用。