[GitHub] [flink-web] klion26 commented on a change in pull request #268: [FLINK-13343][docs-zh] Translate "Contribute Code" page into Chinese
klion26 commented on a change in pull request #268:
URL: https://github.com/apache/flink-web/pull/268#discussion_r426340343
##
File path: contributing/contribute-code.zh.md
##
@@ -136,91 +136,91 @@ Apache Flink is maintained, improved, and extended by
code contributions of volu
-### 1. Create Jira Ticket and Reach Consensus
+### 1. 创建 Jira 工单并达成共识。
-The first step for making a contribution to Apache Flink is to reach consensus
with the Flink community. This means agreeing on the scope and implementation
approach of a change.
+向 Apache Flink 做出贡献的第一步是与 Flink 社区达成共识，这意味着需要一起商定更改的范围和实现的方法。
-In most cases, the discussion should happen in [Flink's bug tracker:
Jira](https://issues.apache.org/jira/projects/FLINK/summary).
+在大多数情况下，我们应该在 [Flink 的 Bug
追踪器：Jira](https://issues.apache.org/jira/projects/FLINK/summary) 中进行讨论。
-The following types of changes require a `[DISCUSS]` thread on the
dev@flink.a.o Flink mailing list:
+以下类型的更改需要向 Flink 的 d...@flink.apache.org 邮件列表发一封以 `[DISCUSS]` 开头的邮件:
- - big changes (major new feature; big refactorings, involving multiple
components)
- - potentially controversial changes or issues
- - changes with very unclear approaches or multiple equal approaches
+ - 重大变化（主要新功能、大重构和涉及多个组件）
+ - 可能存在争议的改动或问题
+ - 采用非常不明确的方法或有多种实现方法
- Do not open a Jira ticket for these types of changes before the discussion
has come to a conclusion.
- Jira tickets based on a dev@ discussion need to link to that discussion and
should summarize the outcome.
+ 在讨论未达成一致之前,不要为这些类型的更改打开 Jira 工单。
+ 基于 dev 邮件讨论的 Jira 工单需要链接到该讨论，并总结结果。
-**Requirements for a Jira ticket to get consensus:**
+**Jira 工单获得共识的要求：**
- - Formal requirements
- - The *Title* describes the problem concisely.
- - The *Description* gives all the details needed to understand the
problem or feature request.
- - The *Component* field is set: Many committers and contributors only
focus on certain subsystems of Flink. Setting the appropriate component is
important for getting their attention.
- - There is **agreement** that the ticket solves a valid problem, and that it
is a **good fit** for Flink.
-The Flink community considers the following aspects:
- - Does the contribution alter the behavior of features or components in a
way that it may break previous users’ programs and setups? If yes, there needs
to be a discussion and agreement that this change is desirable.
- - Does the contribution conceptually fit well into Flink? Is it too much
of a special case such that it makes things more complicated for the common
case, or bloats the abstractions / APIs?
- - Does the feature fit well into Flink’s architecture? Will it scale and
keep Flink flexible for the future, or will the feature restrict Flink in the
future?
- - Is the feature a significant new addition (rather than an improvement
to an existing part)? If yes, will the Flink community commit to maintaining
this feature?
- - Does this feature align well with Flink's roadmap and currently ongoing
efforts?
- - Does the feature produce added value for Flink users or developers? Or
does it introduce the risk of regression without adding relevant user or
developer benefit?
- - Could the contribution live in another repository, e.g., Apache Bahir
or another external repository?
- - Is this a contribution just for the sake of getting a commit in an open
source project (fixing typos, style changes merely for taste reasons)
- - There is **consensus** on how to solve the problem. This includes
considerations such as
-- API and data backwards compatibility and migration strategies
-- Testing strategies
-- Impact on Flink's build time
-- Dependencies and their licenses
+ - 正式要求
+ - 描述问题的 *Title* 要简明扼要。
+ - 在 *Description* 中要提供了解问题或功能请求所需的所有详细信息。
+ - 要设置 *Component* 字段：许多 committers 和贡献者，只专注于 Flink
的某些子系统。设置适当的组件标签对于引起他们的注意很重要。
+ - 社区*一致同意*使用工单是有效解决问题的方法，而且这**非常适合** Flink。
+Flink 社区考虑了以下几个方面：
+ - 这种贡献是否会改变特性或组件的性能，从而破坏以前的用户程序和设置？如果是，那么就需要讨论并达成一致意见，证明这种改变是可取的。
+ - 这个贡献在概念上是否适合 Flink ？这是否是一种特殊场景？支持这种场景后会导致通用的场景变得更复杂，还是使整理抽象或者 APIs
变得更臃肿？
+ - 该功能是否适合 Flink 的架构？它是否易扩展并保持 Flink 未来的灵活性，或者该功能将来会限制 Flink 吗？
+ - 该特性是一个重要的新增内容(而不是对现有内容的改进)吗？如果是，Flink 社区会承诺维护这个特性吗？
+ - 这个特性是否与 Flink 的路线图以及当前正在进行的工作内容一致？
+ - 该特性是否为 Flink 用户或开发人员带来了附加价值？或者它引入了回归的风险而没有给相关的用户或开发人员带来好处？
+ - 该贡献是否存在于其他仓库中，例如 Apache Bahir 或者其他第三方库？
+ - 这仅仅是为了在开源项目中获得提交而做出的贡献吗（仅仅是为了获得贡献而贡献，才去修复拼写错误、改变代码风格）?
+ - 在如何解决这个问题上已有**共识**，包括以下需要考虑的因素
+- API、数据向后兼容性和迁移策略
+- 测试策略
+- 对 Flink 构建时间的影响
+- 依赖关系及其许可证
-If a change is identified as a large or controversial change in the discussion
on Jira, it might require a [Flink Improvement Proposal
(FLIP)](https://cwiki.apache.org/confluence/display/FLINK/Flink+Improvement+Proposals)
or a discussion on the [dev mailing list]( {{ site.base
}}/community.html#mailing-lists) to reach agreement and consensus.
+如果在
[GitHub] [flink-web] klion26 commented on a change in pull request #268: [FLINK-13343][docs-zh] Translate "Contribute Code" page into Chinese
klion26 commented on a change in pull request #268: URL: https://github.com/apache/flink-web/pull/268#discussion_r426209811 ## File path: contributing/contribute-code.zh.md ## @@ -126,7 +126,7 @@ Apache Flink is maintained, improved, and extended by code contributions of volu -Note: trivial hot fixes such as typos or syntax errors can be opened as a [hotfix] pull request, without a Jira ticket. +注意：诸如拼写错误或语法错误之类的简单热修复可以在创建 pull request 时，使用 [hotfix] 标识，可以不创建 Jira 工单。 Review comment: 这句话的意思表达清楚了，如果改成 “注意：诸如拼写错误或语法错误之类的简单热修复可以不创建 Jira 工单，直接提交 [hotfix] pull request” 你觉得会好一点吗？ 主要是后面的“可以不创建 Jira 工单” 感觉应该放在前面（不创建工单，然后直接提交 pull request），然后两个“可以”读起来有一点重复的感觉 ## File path: contributing/contribute-code.zh.md ## @@ -136,91 +136,91 @@ Apache Flink is maintained, improved, and extended by code contributions of volu -### 1. Create Jira Ticket and Reach Consensus +### 1. 创建 Jira 工单并达成共识。 -The first step for making a contribution to Apache Flink is to reach consensus with the Flink community. This means agreeing on the scope and implementation approach of a change. +向 Apache Flink 做出贡献的第一步是与 Flink 社区达成共识，这意味着需要一起商定更改的范围和实现的方法。 -In most cases, the discussion should happen in [Flink's bug tracker: Jira](https://issues.apache.org/jira/projects/FLINK/summary). +在大多数情况下，我们应该在 [Flink 的 Bug 追踪器：Jira](https://issues.apache.org/jira/projects/FLINK/summary) 中进行讨论。 -The following types of changes require a `[DISCUSS]` thread on the dev@flink.a.o Flink mailing list: +以下类型的更改需要向 Flink 的 d...@flink.apache.org 邮件列表发一封以 `[DISCUSS]` 开头的邮件: - - big changes (major new feature; big refactorings, involving multiple components) - - potentially controversial changes or issues - - changes with very unclear approaches or multiple equal approaches + - 重大变化（主要新功能、大重构和涉及多个组件） + - 可能存在争议的改动或问题 + - 采用非常不明确的方法或有多种实现方法 - Do not open a Jira ticket for these types of changes before the discussion has come to a conclusion. - Jira tickets based on a dev@ discussion need to link to that discussion and should summarize the outcome. + 在讨论未达成一致之前,不要为这些类型的更改打开 Jira 工单。 Review comment: “打开” -> “创建"? ## File path: contributing/contribute-code.zh.md ## @@ -136,91 +136,91 @@ Apache Flink is maintained, improved, and extended by code contributions of volu -### 1. Create Jira Ticket and Reach Consensus +### 1. 创建 Jira 工单并达成共识。 -The first step for making a contribution to Apache Flink is to reach consensus with the Flink community. This means agreeing on the scope and implementation approach of a change. +向 Apache Flink 做出贡献的第一步是与 Flink 社区达成共识，这意味着需要一起商定更改的范围和实现的方法。 -In most cases, the discussion should happen in [Flink's bug tracker: Jira](https://issues.apache.org/jira/projects/FLINK/summary). +在大多数情况下，我们应该在 [Flink 的 Bug 追踪器：Jira](https://issues.apache.org/jira/projects/FLINK/summary) 中进行讨论。 -The following types of changes require a `[DISCUSS]` thread on the dev@flink.a.o Flink mailing list: +以下类型的更改需要向 Flink 的 d...@flink.apache.org 邮件列表发一封以 `[DISCUSS]` 开头的邮件: - - big changes (major new feature; big refactorings, involving multiple components) - - potentially controversial changes or issues - - changes with very unclear approaches or multiple equal approaches + - 重大变化（主要新功能、大重构和涉及多个组件） + - 可能存在争议的改动或问题 + - 采用非常不明确的方法或有多种实现方法 - Do not open a Jira ticket for these types of changes before the discussion has come to a conclusion. - Jira tickets based on a dev@ discussion need to link to that discussion and should summarize the outcome. + 在讨论未达成一致之前,不要为这些类型的更改打开 Jira 工单。 + 基于 dev 邮件讨论的 Jira 工单需要链接到该讨论，并总结结果。 -**Requirements for a Jira ticket to get consensus:** +**Jira 工单获得共识的要求：** - - Formal requirements - - The *Title* describes the problem concisely. - - The *Description* gives all the details needed to understand the problem or feature request. - - The *Component* field is set: Many committers and contributors only focus on certain subsystems of Flink. Setting the appropriate component is important for getting their attention. - - There is **agreement** that the ticket solves a valid problem, and that it is a **good fit** for Flink. -The Flink community considers the following aspects: - - Does the contribution alter the behavior of features or components in a way that it may break previous users’ programs and setups? If yes, there needs to be a discussion and agreement that this change is desirable. - - Does the contribution conceptually fit well into Flink? Is it too much of a special case such that it makes things more complicated for the common case, or bloats the abstractions / APIs? - - Does the feature fit well into Flink’s architecture? Will it scale and keep Flink flexible for the future, or will the feature restrict Flink in the future? - - Is the feature a significant new addition (rather than an improvement to an existing part)? If yes, will
[GitHub] [flink-web] klion26 commented on a change in pull request #268: [FLINK-13343][docs-zh] Translate "Contribute Code" page into Chinese
klion26 commented on a change in pull request #268: URL: https://github.com/apache/flink-web/pull/268#discussion_r425633972 ## File path: contributing/contribute-code.zh.md ## @@ -79,44 +79,44 @@ Apache Flink is maintained, improved, and extended by code contributions of volu -Note: The code contribution process has changed recently (June 2019). The community https://lists.apache.org/thread.html/1e2b85d0095331606ad0411ca028f061382af08138776146589914f8@%3Cdev.flink.apache.org%3E;>decided to shift the "backpressure" from pull requests to Jira, by requiring contributors to get consensus (indicated by being assigned to the ticket) before opening a pull request. +注意：最近（2019 年 6 月），代码贡献步骤有改动。社区https://lists.apache.org/thread.html/1e2b85d0095331606ad0411ca028f061382af08138776146589914f8@%3Cdev.flink.apache.org%3E;>决定将原来直接提交 pull request 的方式转移到 Jira 上，要求贡献者在打开 pull request 之前需在 Jira 上达成共识（通过分配到的工单来体现），以减轻 PR review 的压力。 Review comment: 恩，我觉得翻译成 “创建” 是合理的。最近的翻译中还没有提现，可以修改一下 ## File path: contributing/contribute-code.zh.md ## @@ -2,17 +2,17 @@ title: "贡献代码" --- -Apache Flink is maintained, improved, and extended by code contributions of volunteers. We welcome contributions to Flink, but due to the size of the project and to preserve the high quality of the code base, we follow a contribution process that is explained in this document. +Apache Flink 是由志愿者贡献的代码来维护、改进和扩展的。我们欢迎给 Flink 做贡献，但由于项目的规模大，以及为了保持高质量的代码库，本文将阐述我们所遵循的贡献流程。 Review comment: 这个翻译我觉得 ok 的 ## File path: contributing/contribute-code.zh.md ## @@ -136,91 +136,91 @@ Apache Flink is maintained, improved, and extended by code contributions of volu -### 1. Create Jira Ticket and Reach Consensus +### 1. 创建 Jira 工单并达成共识。 -The first step for making a contribution to Apache Flink is to reach consensus with the Flink community. This means agreeing on the scope and implementation approach of a change. +向 Apache Flink 做出贡献的第一步是与 Flink 社区达成共识，这意味着需要一起商定更改的范围和实现的方法。 -In most cases, the discussion should happen in [Flink's bug tracker: Jira](https://issues.apache.org/jira/projects/FLINK/summary). +在大多数情况下，我们应该在 [Flink 的 Bug 追踪器：Jira](https://issues.apache.org/jira/projects/FLINK/summary) 中进行讨论。 -The following types of changes require a `[DISCUSS]` thread on the dev@flink.a.o Flink mailing list: +以下类型的更改需要向 Flink 的 d...@flink.apache.org 邮件列表发一封以 `[DISCUSS]` 开头的邮件: - - big changes (major new feature; big refactorings, involving multiple components) - - potentially controversial changes or issues - - changes with very unclear approaches or multiple equal approaches + - 重大变化（主要新功能、大重构和涉及多个组件） + - 可能存在争议的改动或问题 + - 采用非常不明确的方法或有多种实现方法 - Do not open a Jira ticket for these types of changes before the discussion has come to a conclusion. - Jira tickets based on a dev@ discussion need to link to that discussion and should summarize the outcome. + 在讨论未达成一致之前,不要为这些类型的更改打开 Jira 工单。 + 基于 dev 邮件讨论的 Jira 工单需要链接到该讨论，并总结结果。 -**Requirements for a Jira ticket to get consensus:** +**Jira 工单获得共识的要求：** - - Formal requirements - - The *Title* describes the problem concisely. - - The *Description* gives all the details needed to understand the problem or feature request. - - The *Component* field is set: Many committers and contributors only focus on certain subsystems of Flink. Setting the appropriate component is important for getting their attention. - - There is **agreement** that the ticket solves a valid problem, and that it is a **good fit** for Flink. -The Flink community considers the following aspects: - - Does the contribution alter the behavior of features or components in a way that it may break previous users’ programs and setups? If yes, there needs to be a discussion and agreement that this change is desirable. - - Does the contribution conceptually fit well into Flink? Is it too much of a special case such that it makes things more complicated for the common case, or bloats the abstractions / APIs? - - Does the feature fit well into Flink’s architecture? Will it scale and keep Flink flexible for the future, or will the feature restrict Flink in the future? - - Is the feature a significant new addition (rather than an improvement to an existing part)? If yes, will the Flink community commit to maintaining this feature? - - Does this feature align well with Flink's roadmap and currently ongoing efforts? - - Does the feature produce added value for Flink users or developers? Or does it introduce the risk of regression without adding relevant user or developer benefit? - - Could the contribution live in another repository, e.g., Apache Bahir or another external repository? - - Is this a contribution just for the sake of getting a commit in an open source project (fixing typos, style changes merely for taste reasons) - - There is **consensus** on how to solve the problem. This
[GitHub] [flink-web] klion26 commented on a change in pull request #268: [FLINK-13343][docs-zh] Translate "Contribute Code" page into Chinese
klion26 commented on a change in pull request #268:
URL: https://github.com/apache/flink-web/pull/268#discussion_r422948951
##
File path: contributing/contribute-code.zh.md
##
@@ -2,17 +2,17 @@
title: "贡献代码"
---
-Apache Flink is maintained, improved, and extended by code contributions of
volunteers. We welcome contributions to Flink, but due to the size of the
project and to preserve the high quality of the code base, we follow a
contribution process that is explained in this document.
+Apache Flink 是靠志愿者的代码贡献来得到维护、改进和扩展的项目。我们欢迎给 Flink
做贡献，但由于项目的规模大，为了保持高质量的代码库，我们要求贡献者须遵循本文中的贡献过程说明。
Review comment:
“Apache Flink 是由志愿者贡献的代码来维护、改进和扩展的。”
“但由于项目的规模，以及为了保持高质量的代码库，本文将阐述我们所遵循的流程。” -- 这个地方流程不一定好，也可以看看是否有其他更好的翻译
这个是否会更好一些呢？
##
File path: contributing/contribute-code.zh.md
##
@@ -2,17 +2,17 @@
title: "贡献代码"
---
-Apache Flink is maintained, improved, and extended by code contributions of
volunteers. We welcome contributions to Flink, but due to the size of the
project and to preserve the high quality of the code base, we follow a
contribution process that is explained in this document.
+Apache Flink 是靠志愿者的代码贡献来得到维护、改进和扩展的项目。我们欢迎给 Flink
做贡献，但由于项目的规模大，为了保持高质量的代码库，我们要求贡献者须遵循本文中的贡献过程说明。
-**Please feel free to ask questions at any time.** Either send a mail to the
[dev mailing list]( {{ site.base }}/community.html#mailing-lists ) or comment
on the Jira issue you are working on.
+**请随时提出任何问题！** 可以发送邮件到 [dev mailing list]( {{ site.base
}}/community.html#mailing-lists )，也可以对正在处理的 Jira issue 发表评论。
Review comment:
```suggestion
**请随时提出任何问题！** 可以发送邮件到 [dev mailing list]( {{ site.base
}}/zh/community.html#mailing-lists )，也可以对正在处理的 Jira issue 发表评论。
```
##
File path: contributing/contribute-code.zh.md
##
@@ -79,44 +79,44 @@ Apache Flink is maintained, improved, and extended by code
contributions of volu
-Note: The code contribution process has changed recently (June
2019). The community https://lists.apache.org/thread.html/1e2b85d0095331606ad0411ca028f061382af08138776146589914f8@%3Cdev.flink.apache.org%3E;>decided
to shift the "backpressure" from pull requests to Jira, by requiring
contributors to get consensus (indicated by being assigned to the ticket)
before opening a pull request.
+注意：最近，代码贡献步骤有改动（2019 年 6 月）。社区https://lists.apache.org/thread.html/1e2b85d0095331606ad0411ca028f061382af08138776146589914f8@%3Cdev.flink.apache.org%3E;>决定将原来的
“backpressure”从 pull request 方式转移到 Jira，要求贡献者在打开 pull request 之前需在 Jira
上达成共识（通过分配到的工单来体现）。
Review comment:
"最近，代码贡献步骤有改动（2019 年 6 月）" 这个改成 "最近（2019 年 6 月），代码贡献步骤有改动“ 会更好一些吗？
这里 backpress 可以直接翻译成 ”压力“？
另外中英文之间需要空格，比如 `的 “backpressure”从` 需要改成 `的 “backpressure” 从`
这里的意思是，之前很多人没有在 issue 就方案达成一致，就直接提交 PR 了，导致有很多 PR，造成 Review 压力大，现在需要在提交 PR
之前在 issue 那边达成一致，这样就减少了 PR 边 review 的压力了（具体的需要再组织一下语言）
##
File path: contributing/contribute-code.zh.md
##
@@ -79,44 +79,44 @@ Apache Flink is maintained, improved, and extended by code
contributions of volu
-Note: The code contribution process has changed recently (June
2019). The community https://lists.apache.org/thread.html/1e2b85d0095331606ad0411ca028f061382af08138776146589914f8@%3Cdev.flink.apache.org%3E;>decided
to shift the "backpressure" from pull requests to Jira, by requiring
contributors to get consensus (indicated by being assigned to the ticket)
before opening a pull request.
+注意：最近，代码贡献步骤有改动（2019 年 6 月）。社区https://lists.apache.org/thread.html/1e2b85d0095331606ad0411ca028f061382af08138776146589914f8@%3Cdev.flink.apache.org%3E;>决定将原来的
“backpressure”从 pull request 方式转移到 Jira，要求贡献者在打开 pull request 之前需在 Jira
上达成共识（通过分配到的工单来体现）。
-1Discuss
-Create a Jira ticket or mailing list discussion and reach
consensus
-Agree on importance, relevance, scope of the ticket, discuss the
implementation approach and find a committer willing to review and merge the
change.
-Only committers can assign a Jira ticket.
+1讨论
+在 Jira 上创建工单或邮件列表讨论并达成共识
+商定重要性、相关性、工单的范围，讨论实现方案，并找到愿意审查和合并更改的 committer。
+只有 committers 才能分配 Jira 工单。
-2Implement
-Implement the change according to the Code Style and Quality Guide
and the approach agreed upon in the Jira ticket.
-Only start working on the implementation if there is consensus
on the approach (e.g. you are assigned to the ticket)
+2实现
+根据代码样式和质量指南，以及 Jira
工单中商定的方法去实现更改。
Review comment:
这里的地址也需要加上 "zh" 其他地方也是一样的。（可以参考这个
[wiki](https://cwiki.apache.org/confluence/display/FLINK/Flink+Translation+Specifications)）
这些修改后，你可以在本地执行 `sh build.sh -p` 然后打开网站进行检查（超链接可以自己点击进行检查）
##
File path: contributing/contribute-code.zh.md
##
@@ -126,111 +126,111 @@ Apache Flink is maintained, improved, and extended by
code contributions of volu
-
