GitHub pull request template #2973
Conversation
tautschnig
requested review from
chrisr-diffblue,
kroening,
peterschrammel and
smowton
as code owners
.github/pull_request_template.md
Outdated
| Thank you for your contribution. Please make sure your pull request fulfils all of the below requirements. If you cannot currently tick all the boxes, but would still like to create a PR, then add the label "work in progress" and assign the PR to yourself. | ||
| ---> | ||
|
|
||
| - [ ] Each commit message has a non-empty body, answering the "Why?" question. |
There was a problem hiding this comment.
"...explaining why the change was made"?
.github/pull_request_template.md
Outdated
| ---> | ||
|
|
||
| - [ ] Each commit message has a non-empty body, answering the "Why?" question. | ||
| - [ ] My contribution is formatting in line with CODING_STANDARD.md. |
.github/pull_request_template.md
Outdated
|
|
||
| - [ ] Each commit message has a non-empty body, answering the "Why?" question. | ||
| - [ ] My contribution is formatting in line with CODING_STANDARD.md. | ||
| - [ ] Methods or procedures I have added are documented. |
There was a problem hiding this comment.
...using Doxygen comments at the definition site (not the declaration)
There was a problem hiding this comment.
I have included a reference to CODING_STANDARD.md.
.github/pull_request_template.md
Outdated
| - [ ] Each commit message has a non-empty body, answering the "Why?" question. | ||
| - [ ] My contribution is formatting in line with CODING_STANDARD.md. | ||
| - [ ] Methods or procedures I have added are documented. | ||
| - [ ] Regression or unit tests are included, or existing tests cover the modified code. |
The template provides guidance and a check-list to submitters to make sure code reviews can be as efficient as possible.
tautschnig
force-pushed
the
pr-template
branch
from
caf1f5f to
9a56f42
Compare
There was a problem hiding this comment.
This PR failed Diffblue compatibility checks (cbmc commit: caf1f5f).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/85118287
Status will be re-evaluated on next push.
Please contact @peterschrammel, @thk123, or @allredj for support.
Common spurious failures:
- the cbmc commit has disappeared in the mean time (e.g. in a force-push)
- the author is not in the list of contributors (e.g. first-time contributors).
|
I am going to merge this once CI passes, despite the TG compatibility check failing: I have no idea why a non-code change should be causing this and thus assume it was broken before already. |
There was a problem hiding this comment.
Passed Diffblue compatibility checks (cbmc commit: 9a56f42).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/85120424
The template provides guidance and a check-list to submitters to make sure code
reviews can be as efficient as possible.