Skip to content

Add a guide for adding a JIRA prefix in the test name #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
HyukjinKwon wants to merge 1 commit into from
Closed

Add a guide for adding a JIRA prefix in the test name #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. <a href="https://help.github.com/articles/using-pull-requests/">Open a pull request</a> against
Expand Down
11 changes: 10 additions & 1 deletion site/contributing.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,16 @@ <h3>Pull Request</h3>
<a href="https://github.com/apache/spark">https://github.com/apache/spark</a> if you haven&#8217;t already</li>
<li>Clone your fork, create a new branch, push commits to the branch.</li>
<li>Consider whether documentation or tests need to be added or updated as part of the change,
and add them as needed.</li>
and add them as needed.
<ol>
<li>When you add tests, make sure the tests are self-descriptive.</li>
<li>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.</li>
<li>The JIRA prefix in the test name usually conforms to JIRA ID with a trailing colon, for example,
&#8220;SPARK-XXXXX: test name&#8221;.</li>
</ol>
</li>
<li>Run all tests with <code>./dev/run-tests</code> to verify that the code still compiles, passes tests, and
passes style checks. If style checks fail, review the Code Style Guide below.</li>
<li><a href="https://help.github.com/articles/using-pull-requests/">Open a pull request</a> against
Expand Down