Skip to content
Snippets Groups Projects
Unverified Commit 2a873cda authored by totten's avatar totten Committed by GitHub
Browse files

Merge pull request #474 from totten/master-rexplain

Review Standards - Change `r-jira` to `r-explain`
parents 63b52626 dfcd25c8
No related branches found
No related tags found
No related merge requests found
......@@ -7,7 +7,7 @@ be done, then it can help to post a link to the relevant guideline. This practi
write a long, bespoke blurb.
!!! tip "Standard codes"
Each standard has a code name (e.g. `r-jira`). These make it easier to reference the standards when chatting with others about PR review.
Each standard has a code name (e.g. `r-explain`). These make it easier to reference the standards when chatting with others about PR review.
## Templates
......@@ -18,11 +18,22 @@ You may conduct a structured review, checking each standard in turn. Doing this
## Common standards
### JIRA {:#r-jira}
### Explanation {:#r-explain}
_Standard code: `r-jira`_
_Standard code: `r-explain`_
For most bug-fixes and improvements, there needs to be a [JIRA issue](/tools/issue-tracking.md#jira). However, [NFC](/tools/git.md#nfc) and [WIP](/tools/git.md#wip) PRs may not need an issue.
Ensure the PR has an adequate explanation.
If you were a site-builder reading the PR-log/release-notes and drilled into this PR, would you understand the description? If you were debugging a problem and traced the change back to this PR, would you understand why the change was made?
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.
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}
......
(*CiviCRM Review Template DEL-1.0*)
(*CiviCRM Review Template DEL-1.1*)
<!-- In each category, choose the option that most applies. Delete the others. Optionally, provide more details or explanation in the "Comments". -->
* JIRA ([`r-jira`](https://docs.civicrm.org/dev/en/latest/standards/review/#r-jira))
* JIRA ([`r-explain`](https://docs.civicrm.org/dev/en/latest/standards/review/#r-explain))
* __UNREVIEWED__
* __PASS__ : The PR has a JIRA reference. (Or: it does not need one.)
* __ISSUE__: Please file a ticket in [JIRA](http://issues.civicrm.org/) and place it in the subject
* __PASS__ : The goal/problem/solution have been adequately explained in the PR.
* __PASS__ : The goal/problem/solution have been adequately explained with a link (JIRA, Github, Gitlab, StackExchange).
* __ISSUE__: Please provide a better explanation of the goal/problem being addressed.
* __ISSUE__: Please provide a better explanation of how this solution works.
* __COMMENTS__: <!-- optional -->
* Test results ([`r-test`](https://docs.civicrm.org/dev/en/latest/standards/review/#r-test))
* __UNREVIEWED__
......
(*CiviCRM Review Template MC-1.0*)
(*CiviCRM Review Template MC-1.1*)
<!-- In each category, choose the option that most applies. Optionally, provide more details or explanation in the "Comments". -->
* JIRA ([`r-jira`](https://docs.civicrm.org/dev/en/latest/standards/review/#r-jira))
* [ ] __PASS__ : The PR has a JIRA reference. (Or: it does not need one.)
* [ ] __ISSUE__: Please file a ticket in [JIRA](http://issues.civicrm.org/) and place it in the subject
* JIRA ([`r-explain`](https://docs.civicrm.org/dev/en/latest/standards/review/#r-explain))
* [ ] __PASS__ : The goal/problem/solution have been adequately explained in the PR.
* [ ] __PASS__ : The goal/problem/solution have been adequately explained with a link (JIRA, Github, Gitlab, StackExchange).
* [ ] __ISSUE__: Please provide a better explanation of the goal/problem being addressed.
* [ ] __ISSUE__: Please provide a better explanation of how this solution works.
* [ ] __COMMENTS__: <!-- optional -->
* Test results ([`r-test`](https://docs.civicrm.org/dev/en/latest/standards/review/#r-test))
* [ ] __PASS__: The test results are all-clear.
......
(*CiviCRM Review Template WORD-1.0*)
(*CiviCRM Review Template WORD-1.1*)
<!-- In each category, change the word "Undecided" to "Pass" or "Issue". Add explanatory comments if prompted or desired. -->
* ([`r-jira`](https://docs.civicrm.org/dev/en/latest/standards/review/#r-jira)) __Undecided__
* ([`r-explain`](https://docs.civicrm.org/dev/en/latest/standards/review/#r-explain)) __Undecided__
* ([`r-test`](https://docs.civicrm.org/dev/en/latest/standards/review/#r-test)) __Undecided__
* ([`r-code`](https://docs.civicrm.org/dev/en/latest/standards/review/#r-code)) __Undecided__
* ([`r-doc`](https://docs.civicrm.org/dev/en/latest/standards/review/#r-doc)) __Undecided__
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment