From c9519c1ef53b9ddeb725dd3e12a97383998060d8 Mon Sep 17 00:00:00 2001 From: jtpavlock Date: Sun, 28 Jun 2020 17:32:37 -0500 Subject: [PATCH 1/5] Create pull_request_template.md --- .github/pull_request_template.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..ef2679b50 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,9 @@ +## Description +(...) + +Fixes #(insert issue number here) + +## TODO: +- [ ] docs - If you've added a new command flag, for example, find the appropraite page under docs/ where it needs to be listed +- [ ] Add a **changelog entry** to docs/changelog.rst near the top of the document. +- [ ] Add tests (suggested, but not a hard requirement) From 3282f1565ea80733523ca5d9b323ddabfe1ce1df Mon Sep 17 00:00:00 2001 From: jtpavlock Date: Sun, 28 Jun 2020 17:33:42 -0500 Subject: [PATCH 2/5] Update pull_request_template.md --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ef2679b50..1d6217540 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,5 +5,5 @@ Fixes #(insert issue number here) ## TODO: - [ ] docs - If you've added a new command flag, for example, find the appropraite page under docs/ where it needs to be listed -- [ ] Add a **changelog entry** to docs/changelog.rst near the top of the document. +- [ ] Add a changelog entry to docs/changelog.rst near the top of the document. - [ ] Add tests (suggested, but not a hard requirement) From b458509ba18ba5da6191e2207b4f32d0486c8645 Mon Sep 17 00:00:00 2001 From: jtpavlock Date: Sun, 28 Jun 2020 17:35:08 -0500 Subject: [PATCH 3/5] spelling --- .github/pull_request_template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1d6217540..49982230b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,9 +1,9 @@ ## Description (...) -Fixes #(insert issue number here) +Fixes #(insert issue number here if applicable) ## TODO: -- [ ] docs - If you've added a new command flag, for example, find the appropraite page under docs/ where it needs to be listed +- [ ] docs - If you've added a new command flag, for example, find the appropriate page under docs/ where it needs to be listed - [ ] Add a changelog entry to docs/changelog.rst near the top of the document. - [ ] Add tests (suggested, but not a hard requirement) From def44e6f88fcec0d4bb6586feef3acd96050e9d2 Mon Sep 17 00:00:00 2001 From: jtpavlock Date: Sun, 28 Jun 2020 17:36:40 -0500 Subject: [PATCH 4/5] Update pull_request_template.md --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 49982230b..9abf2cdbd 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -3,7 +3,7 @@ Fixes #(insert issue number here if applicable) -## TODO: +## TODO - [ ] docs - If you've added a new command flag, for example, find the appropriate page under docs/ where it needs to be listed - [ ] Add a changelog entry to docs/changelog.rst near the top of the document. - [ ] Add tests (suggested, but not a hard requirement) From 6411a58c80cfc755af744aae23637720bad632ef Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Mon, 29 Jun 2020 09:08:25 -0400 Subject: [PATCH 5/5] Slight formatting/wording improvements --- .github/pull_request_template.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9abf2cdbd..42cd8169b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,9 +1,11 @@ ## Description + +Fixes #X. + (...) -Fixes #(insert issue number here if applicable) +## To Do -## TODO -- [ ] docs - If you've added a new command flag, for example, find the appropriate page under docs/ where it needs to be listed -- [ ] Add a changelog entry to docs/changelog.rst near the top of the document. -- [ ] Add tests (suggested, but not a hard requirement) +- [ ] Documentation. (If you've add a new command-line flag, for example, find the appropriate page under `docs/` to describe it.) +- [ ] Changelog. (Add an entry to `docs/changelog.rst` near the top of the document.) +- [ ] Tests. (Encouraged but not strictly required.)