From 7de4f55b79b8ca37ad0001724d502aa2c792b792 Mon Sep 17 00:00:00 2001 From: Philip Clark Date: Wed, 20 Dec 2023 15:29:01 -0500 Subject: [PATCH 1/4] Create PULL_REQUEST_TEMPLATE.md Adapt PR Template from https://github.com/TheOdinProject/curriculum/blob/main/.github/PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 34 ++++++++++++++++++++++++++++++++ 1 file changed, 34 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 0000000..5d2351b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,34 @@ + + +## Because + + + +## This PR + +- e.g. Add PR templates + + +## Issue + +Closes #XXXXX + +## Additional Information + + + +## Pull Request Requirements + +- [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/.github/blob/main/CONTRIBUTING.md) +- [ ] The title of this PR follows the `location of change: brief description of change` format, e.g. `Menu.js: Fix link text` +- [ ] The `Because` section summarizes the reason for this PR +- [ ] The `This PR` section has a bullet point list describing the changes in this PR +- [ ] If this PR addresses an open issue, it is linked in the `Issue` section + + + From 8265518d43c7aa04f1a4d6cc2e1dc34d29d380ec Mon Sep 17 00:00:00 2001 From: Philip Clark Date: Wed, 20 Dec 2023 15:42:11 -0500 Subject: [PATCH 2/4] Create demo_change.md --- demo_change.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 demo_change.md diff --git a/demo_change.md b/demo_change.md new file mode 100644 index 0000000..bacb6bb --- /dev/null +++ b/demo_change.md @@ -0,0 +1 @@ +Testing PR template From 4fdafbae48862e029c13df9bff362363776267c2 Mon Sep 17 00:00:00 2001 From: Philip Clark Date: Wed, 20 Dec 2023 16:13:53 -0500 Subject: [PATCH 3/4] Update PULL_REQUEST_TEMPLATE.md Update wording to make the PR template more beginner-friendly --- .github/PULL_REQUEST_TEMPLATE.md | 44 +++++++++++++++++++------------- 1 file changed, 26 insertions(+), 18 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5d2351b..0b430dc 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,34 +1,42 @@ -## Because - +## Reason for PR + +e.g The added feature is helpful because... -## This PR - -- e.g. Add PR templates +## Changes in this PR + + - e.g. Add feature + - e.g. Update something -## Issue - + + Closes (replace with #issueNumber. e.g. Closes #1) ---> -Closes #XXXXX ## Additional Information - + + + e.g. For more information on xx, see xx ## Pull Request Requirements - -- [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/.github/blob/main/CONTRIBUTING.md) -- [ ] The title of this PR follows the `location of change: brief description of change` format, e.g. `Menu.js: Fix link text` -- [ ] The `Because` section summarizes the reason for this PR -- [ ] The `This PR` section has a bullet point list describing the changes in this PR -- [ ] If this PR addresses an open issue, it is linked in the `Issue` section + + + - [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/.github/blob/main/CONTRIBUTING.md) + - [ ] The title of this PR follows the `location of change: brief description of change` format, e.g. `Menu.js: Fix link text` + - [ ] The `Reason for PR` section summarizes the reason for this PR + - [ ] The `Changes in this PR` section has a bullet point list describing the changes in this PR + - [ ] If this PR addresses an open issue, it is linked in the `Issue` section + + From ccbe7a259df6d8fdcd5d5285b7ec1ac0e0b4bc8e Mon Sep 17 00:00:00 2001 From: Philip Clark Date: Wed, 20 Dec 2023 16:32:05 -0500 Subject: [PATCH 4/4] Delete demo_change.md --- demo_change.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 demo_change.md diff --git a/demo_change.md b/demo_change.md deleted file mode 100644 index bacb6bb..0000000 --- a/demo_change.md +++ /dev/null @@ -1 +0,0 @@ -Testing PR template