JAX 增强提案 (JEP)

JAX 增强提案 (JEP)#

大多数更改可以通过简单的 issue/讨论和 pull request 来讨论。

但是,一些更改的范围较大或需要更多讨论,这些更改应作为 JEP 来实施。这允许编写更长的文档,这些文档本身可以在 pull request 中进行讨论。

JEP 的结构尽可能保持轻量级,以便开始,并且以后可能会扩展。

何时应该使用 JEP#

  • 当您的更改需要设计文档时。我们更喜欢将设计收集为 JEP,以便更好地发现和进一步参考。

  • 当您的更改需要广泛讨论时。在 issue 或 pull request 上进行相对简短的讨论是可以的,但是当讨论变得更长时,这对于以后的消化来说就不切实际了。JEP 允许使用讨论摘要更新主文档,并且这些更新本身可以在添加 JEP 的 pull request 中进行讨论。

如何启动 JEP#

首先,使用 JEP 标签 创建一个 issue。所有与 JEP 相关的 pull request(即添加 JEP 本身以及任何实现 pull request)都应链接到此 issue。

然后创建一个 pull request,添加一个名为 %d-{short-title}.md 的文件 - 其中数字是 issue 编号。

事后从其他文档、issue 和 pull request 转换了一些早期的 JEP,因此它们可能没有完全反映上面概述的过程。