From b18f0c3d9cd17e1e074b47128be27610a215f112 Mon Sep 17 00:00:00 2001 From: Tim Otten <totten@civicrm.org> Date: Wed, 21 Feb 2018 08:46:07 -0800 Subject: [PATCH] Update review.md --- docs/standards/review.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/standards/review.md b/docs/standards/review.md index 860d436c..f01fef71 100644 --- a/docs/standards/review.md +++ b/docs/standards/review.md @@ -28,7 +28,12 @@ If you were a site-builder reading the PR-log/release-notes and drilled into thi It is strongly encouraged that PR's include URLs/hyperlinks for any explanatory material (when available) -- such as a [JIRA issue](/tools/issue-tracking.md#jira), [Gitlab issue](http://lab.civicrm.org/), [StackExchange question](https://civicrm.stackexchange.com/), related PR, or [Mattermost chat](https://chat.civicrm.org). However, hyperlinks are not a substitute for a description. The PR should still have a description. -Exception: [NFC](/tools/git.md#nfc) and [WIP](/tools/git.md#wip) PRs may not need a detailed explanation. +PR descriptions should generally follow the [pull-request template](https://github.com/civicrm/civicrm-core/blob/master/.github/PULL_REQUEST_TEMPLATE.md), although this could be waived if another structure is more expressive. + +__Exception__: + +* [WIP](/tools/git.md#wip) PRs do not need a detailed explanation until they're ready for earnest review. +* Genuine [NFC](/tools/git.md#nfc) PRs do not need a detailed explanation. ### Test results {:#r-test} -- GitLab