From bffffffc95a104bc4794e591940930b89e47decf Mon Sep 17 00:00:00 2001 From: "F. Eugene Aumson" Date: Mon, 16 Jul 2018 15:21:39 -0400 Subject: 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. --- PULL_REQUEST_TEMPLATE.md | 12 +++++------- 1 file 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: - + - - -* [ ] 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. -- cgit v1.2.3