aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorF. Eugene Aumson <feuGeneA@users.noreply.github.com>2018-07-17 03:21:39 +0800
committerF. Eugene Aumson <gene@aumson.org>2018-07-17 05:50:24 +0800
commitbffffffc95a104bc4794e591940930b89e47decf (patch)
treee09f3a80e96092b3784e9b69533f3351e1297cc8
parent01789e67509a2d87d9056f6b9ef9ff48eee88cdd (diff)
downloaddexon-sol-tools-bffffffc95a104bc4794e591940930b89e47decf.tar
dexon-sol-tools-bffffffc95a104bc4794e591940930b89e47decf.tar.gz
dexon-sol-tools-bffffffc95a104bc4794e591940930b89e47decf.tar.bz2
dexon-sol-tools-bffffffc95a104bc4794e591940930b89e47decf.tar.lz
dexon-sol-tools-bffffffc95a104bc4794e591940930b89e47decf.tar.xz
dexon-sol-tools-bffffffc95a104bc4794e591940930b89e47decf.tar.zst
dexon-sol-tools-bffffffc95a104bc4794e591940930b89e47decf.zip
make PR template checklist more useful
Goal is to make it so that every PR should check off every checklist item before it is considered complete. Removed mention of labels. Since contributors outside the org don't have permission to add labels, it's not possible for any such contributor to ever check those items off. Opted instead to prescribe bracketed PR title prefixes, which are accessible to all. Re-ordered checklist items to better represent chronological progress.
-rw-r--r--PULL_REQUEST_TEMPLATE.md12
1 files changed, 5 insertions, 7 deletions
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
index 257c91025..63ef8db3d 100644
--- a/PULL_REQUEST_TEMPLATE.md
+++ b/PULL_REQUEST_TEMPLATE.md
@@ -18,12 +18,10 @@
## Checklist:
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- The following points should be used to indicate the progress of your PR. Put an `x` in all the boxes that apply right now, and come back over time and check them off as you make progress. If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
-<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
-
-* [ ] Change requires a change to the documentation.
-* [ ] Added tests to cover my changes.
+* [ ] Prefixed the title of this PR with `[WIP]` if it is a work in progress.
+* [ ] Prefixed the title of this PR with bracketed package name(s) corresponding to the changed package(s). For example: `[sol-cov] Fixed bug`.
+* [ ] Added tests to cover my changes, or decided that tests would be too impractical.
+* [ ] Updated documentation, or decided that no doc change is needed.
* [ ] Added new entries to the relevant CHANGELOG.jsons.
-* [ ] Labeled this PR with the 'WIP' label if it is a work in progress.
-* [ ] Labeled this PR with the labels corresponding to the changed package.