Skip to content

Commit

Permalink
Polish the document of the release guide
Browse files Browse the repository at this point in the history
  • Loading branch information
WillemJiang authored Apr 25, 2023
1 parent dec85bb commit c702b52
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions content/post/apache-policy/asf-release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ authors:

相信对于每个初入 `ASF` 的孵化项目来说,**第一次**发版都会遇到不少小问题和麻烦事,尤其以 `License/Notice/Copyright` 相关的问题为典型代表,思考了下主要原因可能有:

- ASF 官方的文档颇为零散,社区的普通开发者和未参与发版的经常没有耐心通读所有文档以及注意到**关键**事项 (或理解有偏差)
- ASF 官方的文档颇为零散,社区的普通开发者和未参与发版的同学经常没有耐心通读所有文档以及注意到**关键**事项 (或理解有偏差)
- ASF 官方文档对于有些描述仍较为**模糊**, 或者它直接建议 PMC/Mentor/Mail 来讨论决策,但这部分结论通常没有更新记录到文档中
- ASF 官方没有给大家推荐类似 `skywalking-eye` (header/dependency) 的自动化检查,这些对初次发版的同学可能会有许多帮助
- ASF 官方没有给大家推荐类似 `skywalking-eye` (header/dependency) 的自动化检查工具,这些工具对初次发版的同学可能会有许多帮助
- ASF 文档中对有些规范/规则并未**严格**要求, 但发版投票时不同的 Reviewer 可能有不同的习惯/偏好, 从而会提出一些改进"**建议**"
- "中/英"语言/语义上的理解偏差,从而误解了某些内容
- "中/英"语言/语义上的理解偏差,从而导致了某些内容的误解

借着 [Apache HugeGraph](https://github.com/apache/incubator-hugegraph) 首次发版的机会,我也顺便总结了一些 PR / 邮件中遇到的事项和经验,由于是个人理解,可能存在不严谨的地方,欢迎大家一起来 review 和补充完善,避免相似的问题反复出现在 `incubator` 项目的发版过程中:)

Expand All @@ -43,7 +43,7 @@ authors:

#### ASF & Apache

新同学可能会比较困惑为何常看到 ASF 的邮件/文档中不直接使用 `Apache 项目` 这样的描述, 而建议/习惯使用 `ASF 项目`. 这是因为 `Apache 项目` 容易产生歧义:**任何**使用 `Apache` 许可协议的项目都可这样称呼, 但是 `ASF` (基金会) 的项目有一些单独的**要求/限定**的, 描述上加以区分可避免大家**误解**对应的含义,
新同学可能会比较困惑为何常看到 ASF 的邮件/文档中不直接使用 `Apache 项目` 这样的描述, 而建议/习惯使用 `ASF 项目`. 这是因为 `Apache 项目` 容易产生歧义:因为 Apache 还有很多其他含义,可能会指使用了 Apache 软件许可证的项目, 但是 `ASF` (基金会) 的项目有一些单独的**要求/限定**的, 描述上加以区分可避免大家**误解**对应的含义,
也就能更好理解引入非 ASF 名下的 `Apache` 项目和引入 `ASF`名下项目依赖的区别了


Expand Down

0 comments on commit c702b52

Please sign in to comment.