From fb0aeacfa052b9273d6fac917c5885c4bae3db30 Mon Sep 17 00:00:00 2001 From: HyukjinKwon Date: Thu, 14 Nov 2019 21:02:07 +0900 Subject: [PATCH] Add a guide for adding a JIRA prefix in the test name --- contributing.md | 6 ++++++ site/contributing.html | 11 ++++++++++- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/contributing.md b/contributing.md index aef74a4063b..6717102bfd4 100644 --- a/contributing.md +++ b/contributing.md @@ -304,6 +304,12 @@ Example: `Fix typos in Foo scaladoc` 1. Clone your fork, create a new branch, push commits to the branch. 1. Consider whether documentation or tests need to be added or updated as part of the change, and add them as needed. + 1. When you add tests, make sure the tests are self-descriptive. + 1. Also, you should consider adding a JIRA ID as a prefix of the tests when your PR targets + to fix a specific issue. In practice, usually it is added when a JIRA type is a bug + or a PR adds a couple of tests to an existing test class. + 1. The JIRA prefix in the test name usually conforms to JIRA ID with a trailing colon, for example, + "SPARK-XXXXX: test name". 1. Run all tests with `./dev/run-tests` to verify that the code still compiles, passes tests, and passes style checks. If style checks fail, review the Code Style Guide below. 1. Open a pull request against diff --git a/site/contributing.html b/site/contributing.html index f60d2cab64b..1f92b2d085a 100644 --- a/site/contributing.html +++ b/site/contributing.html @@ -537,7 +537,16 @@

Pull Request

https://github.com/apache/spark if you haven’t already
  • Clone your fork, create a new branch, push commits to the branch.
  • Consider whether documentation or tests need to be added or updated as part of the change, -and add them as needed.
    • +and add them as needed. +
      +
    1. When you add tests, make sure the tests are self-descriptive.
      2. +
    2. Also, you should consider adding a JIRA ID as a prefix of the tests when your PR targets + to fix a specific issue. In practice, usually it is added when a JIRA type is a bug + or a PR adds a couple of tests to an existing test class.
      3. +
    3. The JIRA prefix in the test name usually conforms to JIRA ID with a trailing colon, for example, + “SPARK-XXXXX: test name”.
      4. +
    +
  • Run all tests with ./dev/run-tests to verify that the code still compiles, passes tests, and passes style checks. If style checks fail, review the Code Style Guide below.
  • Open a pull request against