Repository: flink-web Updated Branches: refs/heads/asf-site 0b278cc29 -> 2b0c472a1
Fix typo in contribute-code: "sensitive" vs "sensible" Project: http://git-wip-us.apache.org/repos/asf/flink-web/repo Commit: http://git-wip-us.apache.org/repos/asf/flink-web/commit/98cf557a Tree: http://git-wip-us.apache.org/repos/asf/flink-web/tree/98cf557a Diff: http://git-wip-us.apache.org/repos/asf/flink-web/diff/98cf557a Branch: refs/heads/asf-site Commit: 98cf557a61ef9a4ee24dc7045253dedd672b56ee Parents: 0b278cc Author: Andrew Janke <[email protected]> Authored: Mon Jun 4 20:04:19 2018 -0400 Committer: Fabian Hueske <[email protected]> Committed: Tue Jun 5 14:40:11 2018 +0200 ---------------------------------------------------------------------- contribute-code.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink-web/blob/98cf557a/contribute-code.md ---------------------------------------------------------------------- diff --git a/contribute-code.md b/contribute-code.md index 39b1bb2..5bd3a75 100755 --- a/contribute-code.md +++ b/contribute-code.md @@ -18,7 +18,7 @@ This document contains everything you need to know about contributing code to Ap â¦please make sure there is a Jira issue that corresponds to your contribution. This is a *general rule* that the Flink community follows for all code contributions, including bug fixes, improvements, or new features, with an exception for *trivial* hot fixes. If you would like to fix a bug that you found or if you would like to add a new feature or improvement to Flink, please follow the [File a bug report]({{ site.baseurl }}/how-to-contribute.html#file-a-bug-report) or [Propose an improvement or a new feature]({{ site.baseurl }}/how-to-contribute.html#propose-an-improvement-or-a-new-feature) guidelines to open an issue in [Flink's Jira](http://issues.apache.org/jira/browse/FLINK) before starting with the implementation. -If the description of a Jira issue indicates that its resolution will touch sensible parts of the code base, be sufficiently complex, or add significant amounts of new code, the Flink community might request a design document. (Most contributions should not require a design document.) The purpose of this document is to ensure that the overall approach to address the issue is sensible and agreed upon by the community. Jira issues that require a design document are tagged with the **`requires-design-doc`** label. The label can be attached by any community member who feels that a design document is necessary. A good description helps to decide whether a Jira issue requires a design document or not. The design document must be added or attached to or linked from the Jira issue and cover the following aspects: +If the description of a Jira issue indicates that its resolution will touch sensitive parts of the code base, be sufficiently complex, or add significant amounts of new code, the Flink community might request a design document. (Most contributions should not require a design document.) The purpose of this document is to ensure that the overall approach to address the issue is sensible and agreed upon by the community. Jira issues that require a design document are tagged with the **`requires-design-doc`** label. The label can be attached by any community member who feels that a design document is necessary. A good description helps to decide whether a Jira issue requires a design document or not. The design document must be added or attached to or linked from the Jira issue and cover the following aspects: - Overview of the general approach. - List of API changes (changed interfaces, new and deprecated configuration parameters, changed behavior, â¦).
