diff options
author | David James <davidjames@google.com> | 2016-09-16 20:29:37 +0000 |
---|---|---|
committer | android-build-merger <android-build-merger@google.com> | 2016-09-16 20:29:37 +0000 |
commit | de5f20cf231e0247660233e772926cd60a32e395 (patch) | |
tree | d13b663ed164def848c9d06f1ff15836ce93aeba | |
parent | 28653061a9fcc71a88941789a8e8e510cc05ef1a (diff) | |
parent | f7cbec93f29dcb986de22df4dc8a30094ff9a683 (diff) | |
download | repohooks-de5f20cf231e0247660233e772926cd60a32e395.tar.gz |
Add a better description of why users should include Test in messages. am: ddb342b01e am: 3287a9ae75
am: f7cbec93f2
Change-Id: I67cbff7b83c858046d51a4762d6df619ef10b2b4
-rw-r--r-- | rh/hooks.py | 30 |
1 files changed, 28 insertions, 2 deletions
diff --git a/rh/hooks.py b/rh/hooks.py index e250015..0a67280 100644 --- a/rh/hooks.py +++ b/rh/hooks.py @@ -257,6 +257,33 @@ def check_commit_msg_changeid_field(project, commit, desc, _diff, options=None): project, commit, error=error)] +TEST_MSG = """Commit message is missing a "Test:" line. It must match: +%s + +The Test: stanza is free-form and should describe how you tested your change. +As a CL author, you'll have a consistent place to describe the testing strategy +you use for your work. As a CL reviewer, you'll be reminded to discuss testing +as part of your code review, and you'll more easily replicate testing when you +patch in CLs locally. + +Some examples below: + +Test: make WITH_TIDY=1 mmma art +Test: make test-art +Test: manual - took a photo +Test: refactoring CL. Existing unit tests still pass. + +Check the Gerrit history for more examples. It's a free-form field, so we urge +you to develop conventions that make sense for your project. Note that many +projects use exact test commands, which are perfectly fine. + +Adding good automated tests with new code is critical to our goals of keeping +Android stable and constantly improving Android quality. Please use Test: to +highlight this area of your development. And reviewers, please insist on +high-quality Test: descriptions. +""" + + def check_commit_msg_test_field(project, commit, desc, _diff, options=None): """Check the commit message for a 'Test:' line.""" field = 'Test' @@ -272,8 +299,7 @@ def check_commit_msg_test_field(project, commit, desc, _diff, options=None): found.append(line) if not found: - error = ('Commit message is missing a "%s:" line. It must match:\n' - '%s') % (field, regex) + error = TEST_MSG % (regex) else: return |