Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: add Precommit Tests section with info about leading zeroes in patch numbers from HIVE-12981 comments; misc. changes

...

After you have committed a change or set of changes to your local repository, you need to create a patch to post on the JIRA. The naming convention for patches is:

Code Block
HIVE-<JIRA-NUMBER>[.<patch-num>][-<branch-name>].patch

...

A patch for the same JIRA intended to be applied to the llap branch would be named HIVE-9999-llap.patch".

The following git command creates a patch:

Code Block
git diff --no-prefix <commit> > HIVE-1234.1.patch

...

  • reformat code unrelated to the bug being fixed: formatting changes should be separate patches/commits;
  • comment out code that is now obsolete: just remove it;
  • insert comments around each change, marking the change: folks can use subversion git to figure out what's changed and by whom;
  • make things public which are not required by end users.

...

  • try to adhere to the coding style of files you edit;
  • comment code whose function or rationale is not obvious;
  • add one or more unit tests (see Add a Unit Test above);
  • update documentation (e.g., such as Javadocs including package.html files , hive-default.xml.template, this wiki, and so on)and this wiki).

Precommit Tests by Hive QA

If the name of your patch conforms to the naming convention shown above, the automated testing system will run precommit tests and post the results as a JIRA comment from Hive QA. The results give advisory +1 or -1 votes (SUCCESS or ERROR) based on whether the all of the tests executed successfully and, more recently, whether existing tests are modified or new tests are included in the patch to cover the code changes.  For examples, see the Hive QA comments on HIVE-9534 and HIVE-11752.

Patches with nonconforming names are ignored by Hive QA. One leading zero can be used in <patch-num>, such as "HIVE-9999.02.patch", but multiple leading zeros are not accepted (see comments on HIVE-12981).

To retest a patch, you can cancel it and then resubmit it.  If you do not cancel before resubmitting, Hive QA will ignore it.

To prevent precommit testing, include the case-sensitive phrase NO PRECOMMIT TESTS in the Description section of the JIRA issue. You can remove it later as needed.  For examples, see HIVE-5289, HIVE-7343, and HIVE-7375.

Attaching and Submitting a Patch

...