Repository: spark-website Updated Branches: refs/heads/asf-site 9ba1fcee8 -> a45ba4718
improve the document about contributing to bug reports Recently we hit many correctness bugs, and some of them do not get enough attention. I want to highlight the importance of data correctness/data loss issues, and suggest contributors to describe how the bug was introduced, so that people can quickly understand the bug. It's also possible that the reporter doesn't realize it's a correctness bug, by looking at how the bug was introduced, other people can point it out. Author: Wenchen Fan <[email protected]> Closes #153 from cloud-fan/contribute. Project: http://git-wip-us.apache.org/repos/asf/spark-website/repo Commit: http://git-wip-us.apache.org/repos/asf/spark-website/commit/a45ba471 Tree: http://git-wip-us.apache.org/repos/asf/spark-website/tree/a45ba471 Diff: http://git-wip-us.apache.org/repos/asf/spark-website/diff/a45ba471 Branch: refs/heads/asf-site Commit: a45ba471863198d6d6e9f7c50438d6dced3b3839 Parents: 9ba1fce Author: Wenchen Fan <[email protected]> Authored: Sat Oct 6 11:09:43 2018 -0500 Committer: Sean Owen <[email protected]> Committed: Sat Oct 6 11:09:43 2018 -0500 ---------------------------------------------------------------------- contributing.md | 12 ++++++++++++ site/contributing.html | 11 +++++++++++ 2 files changed, 23 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/spark-website/blob/a45ba471/contributing.md ---------------------------------------------------------------------- diff --git a/contributing.md b/contributing.md index 77f57fb..fd1878f 100644 --- a/contributing.md +++ b/contributing.md @@ -87,6 +87,18 @@ and ideally reproduce the bug. Simply encountering an error does not mean a bug reported; as below, search JIRA and search and inquire on the Spark user / dev mailing lists first. Unreproducible bugs, or simple error reports, may be closed. +It's very helpful if the bug report has a description about how the bug was introduced, by +which commit, so that reviewers can easily understand the bug. It also helps committers to +decide how far the bug fix should be backported, when the pull request is merged. The pull +request to fix the bug should narrow down the problem to the root cause. + +Performance regression is also one kind of bug. The pull request to fix a performance regression +must provide a benchmark to prove the problem is indeed fixed. + +Note that, data correctness/data loss bugs are very serious. Make sure the corresponding bug +report JIRA ticket is labeled as `correctness` or `data-loss`. If the bug report doesn't get +enough attention, please send an email to `[email protected]`, to draw more attentions. + It is possible to propose new features as well. These are generally not helpful unless accompanied by detail, such as a design document and/or code change. Large new contributions should consider <a href="https://spark-packages.org/";>spark-packages.org</a> first (see above), http://git-wip-us.apache.org/repos/asf/spark-website/blob/a45ba471/site/contributing.html ---------------------------------------------------------------------- diff --git a/site/contributing.html b/site/contributing.html index a23d5fe..59a26f6 100644 --- a/site/contributing.html +++ b/site/contributing.html @@ -280,6 +280,17 @@ and ideally reproduce the bug. Simply encountering an error does not mean a bug reported; as below, search JIRA and search and inquire on the Spark user / dev mailing lists first. Unreproducible bugs, or simple error reports, may be closed.</p> +<p>It’s very helpful if the bug report has a description about how the bug was introduced, by +which commit, so that reviewers can easily understand the bug. It also helps committers to +decide how far the bug fix should be backported, when the pull request is merged.</p> + +<p>Performance regression is also one kind of bug. The pull request to fix a performance regression +must provide a benchmark to prove the problem is indeed fixed.</p> + +<p>Note that, data correctness/data loss bugs are very serious. Make sure the corresponding bug +report JIRA ticket is labeled as <code>correctness</code> or <code>data-loss</code>. If the bug report doesn’t get +enough attention, please send an email to <code>[email protected]</code>, to draw more attentions.</p> + <p>It is possible to propose new features as well. These are generally not helpful unless accompanied by detail, such as a design document and/or code change. Large new contributions should consider <a href="https://spark-packages.org/";>spark-packages.org</a> first (see above), --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
