diff options
author | Xo Wang <xow@google.com> | 2018-01-16 18:08:17 -0800 |
---|---|---|
committer | Gunnar Mills <gmills@us.ibm.com> | 2018-02-12 17:14:06 +0000 |
commit | 9af10b2aebccb47f5095e5ed5c3c887e309ff02c (patch) | |
tree | d2ca6ed3dd6ddb06075703ef25141a6053f45ad2 | |
parent | 325f4358872e0d33f06e1d98ab7d8b1b2405d7d4 (diff) | |
download | openbmc-docs-9af10b2aebccb47f5095e5ed5c3c887e309ff02c.tar.gz openbmc-docs-9af10b2aebccb47f5095e5ed5c3c887e309ff02c.zip |
contributing: Add testing expectation, commit message requirement
Tested: Documentation change; no code affected.
Signed-off-by: Xo Wang <xow@google.com>
Change-Id: Ie7064b1aea31906b59c2672f6ded9509a62b8a17
-rw-r--r-- | contributing.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md index c4796ab..06cc7d6 100644 --- a/contributing.md +++ b/contributing.md @@ -86,6 +86,12 @@ usually better. However, if there is no clear division, a larger patch is okay. During development, it can be useful to consider how your change can be submitted as logical units. +Each commit is expected to be tested. The expectation of testing may vary from +subproject to subproject, but will typically include running all applicable +automated tests and performing manual testing. Each commit should be tested +separately, even if they are submitted together (an exception is when commits +to different projects depend on each other). + Commit messages are important. They should describe why the change is needed, and what effects it will have on the system. Do not describe the actual code change made by the patch; that's what the patch itself is for. @@ -93,6 +99,13 @@ code change made by the patch; that's what the patch itself is for. Use your full name for contributions, and include a "Signed-off-by" line, to indicate that you agree to the Developer's Certificate of Origin (see below). +Commit messages should include a "Tested" field describing how you tested the +code changes in the patch. Example: +``` + Tested: I ran unit tests with "make check" (added 2 new tests) and manually + tested on Witherspoon that Foo daemon no longer crashes at boot. +``` + Ensure that your patch doesn't change unrelated areas. Be careful of accidental whitespace changes - this makes review unnecessarily difficult. |