From cffabb8f7d33a7681ad59fadd44ce0258331fc8a Mon Sep 17 00:00:00 2001 From: Ryan Maleki Date: Mon, 25 Nov 2024 19:37:42 -0800 Subject: [PATCH 01/11] add .github/pull-request-template.md --- .github/pull-request-template.md | 16 ++++++++++++++++ 1 file changed, 16 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..1c4b6e8 --- /dev/null +++ b/.github/pull-request-template.md @@ -0,0 +1,16 @@ + + +Fixes #N/A + +**What is being changed?** + +**Why is this a good idea?** + +**PR Opener Check List** +- [ ] Do lint checks pass? +- [ ] Do all tests pass +- [ ] Does code coverage stay at 100%? +- [ ] Are all open concerns addressed? +- [ ] Is change approved? + +By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. From 3edd8548bed2b1da9339872e2a99c0029d203791 Mon Sep 17 00:00:00 2001 From: Ryan Maleki Date: Mon, 25 Nov 2024 21:52:50 -0800 Subject: [PATCH 02/11] lint issue --- .github/pull-request-template.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md index 1c4b6e8..6b8d6e2 100644 --- a/.github/pull-request-template.md +++ b/.github/pull-request-template.md @@ -1,12 +1,11 @@ - +#Fixes #N/A -Fixes #N/A +## What is being changed? -**What is being changed?** +## Why is this a good idea? -**Why is this a good idea?** +## PR Opener Check List -**PR Opener Check List** - [ ] Do lint checks pass? - [ ] Do all tests pass - [ ] Does code coverage stay at 100%? From 427326e3afaddb7136c5f12d926ab58b5064fd15 Mon Sep 17 00:00:00 2001 From: Ryan Maleki Date: Mon, 25 Nov 2024 21:54:25 -0800 Subject: [PATCH 03/11] add thank you comment --- .github/pull-request-template.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md index 6b8d6e2..797f86d 100644 --- a/.github/pull-request-template.md +++ b/.github/pull-request-template.md @@ -1,4 +1,13 @@ -#Fixes #N/A + + +# Fixes #N/A ## What is being changed? From 4db6f30f9067e78b5b812ac3d9d711abdffa428e Mon Sep 17 00:00:00 2001 From: Ryan Maleki Date: Mon, 25 Nov 2024 21:56:46 -0800 Subject: [PATCH 04/11] add comments --- .github/pull-request-template.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md index 797f86d..dd569ac 100644 --- a/.github/pull-request-template.md +++ b/.github/pull-request-template.md @@ -7,12 +7,25 @@ the change. --> -# Fixes #N/A +# Fixes #N/A ## What is being changed? + + ## Why is this a good idea? + + ## PR Opener Check List - [ ] Do lint checks pass? From da71bb17e9845b33dad6352ba425311879cc9460 Mon Sep 17 00:00:00 2001 From: Ryan Maleki Date: Mon, 25 Nov 2024 22:03:03 -0800 Subject: [PATCH 05/11] get rid of check list --- .github/pull-request-template.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md index dd569ac..24637c3 100644 --- a/.github/pull-request-template.md +++ b/.github/pull-request-template.md @@ -26,12 +26,4 @@ make anything better? --> -## PR Opener Check List - -- [ ] Do lint checks pass? -- [ ] Do all tests pass -- [ ] Does code coverage stay at 100%? -- [ ] Are all open concerns addressed? -- [ ] Is change approved? - By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. From 429a089c37c9370882d1944fd88deeb134c47450 Mon Sep 17 00:00:00 2001 From: Ryan Maleki Date: Mon, 25 Nov 2024 22:06:26 -0800 Subject: [PATCH 06/11] re-organize --- .github/pull-request-template.md | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md index 24637c3..98f79c2 100644 --- a/.github/pull-request-template.md +++ b/.github/pull-request-template.md @@ -1,29 +1,20 @@ - - -# Fixes #N/A +the change. --> ## What is being changed? - +## What are the advantages of this change over what exists? + -## Why is this a good idea? - By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. From b2f94ea5a6699a7d77fa298c492fe8eb88905dbf Mon Sep 17 00:00:00 2001 From: Ryan Maleki Date: Mon, 25 Nov 2024 22:41:31 -0800 Subject: [PATCH 07/11] fix lint issues --- .github/ISSUE_TEMPLATE/bug_report.md | 5 +++++ .github/pull-request-template.md | 3 --- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f1c45f1..830cad5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,16 +8,21 @@ assignees: '' --- ## Describe the problem + A clear and concise description of what the problem is. ## Expected behavior + A clear and concise description of what you expected to happen. ## Running code examples + If applicable, try to add executable code to and share the url to illustrate your point. e.g. https://go.dev/play/p/UfJNprdqDJ6 ## What effort have you taken to solve this problem? + Describe what effort you have done so far to solve this challenge? ## Additional context + Add any other context about the problem here. diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md index 98f79c2..882d673 100644 --- a/.github/pull-request-template.md +++ b/.github/pull-request-template.md @@ -8,13 +8,10 @@ the change. --> ## What is being changed? - ## What are the advantages of this change over what exists? - ## What are the downsides of this change? - By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. From a1db3b1f9501d1705b1fba026073a8e0d472e621 Mon Sep 17 00:00:00 2001 From: Ryan Maleki Date: Mon, 25 Nov 2024 22:54:09 -0800 Subject: [PATCH 08/11] get rid of extra lines --- .github/pull-request-template.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md index 882d673..c78e645 100644 --- a/.github/pull-request-template.md +++ b/.github/pull-request-template.md @@ -7,11 +7,8 @@ the change. --> ## What is being changed? - ## What are the advantages of this change over what exists? - ## What are the downsides of this change? - By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. From 24ca85bc19be5a8cc9980cd56c781730393263ef Mon Sep 17 00:00:00 2001 From: Ryan Maleki Date: Mon, 25 Nov 2024 22:58:50 -0800 Subject: [PATCH 09/11] no bare URLs --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 830cad5..8c3f4dc 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -17,7 +17,7 @@ A clear and concise description of what you expected to happen. ## Running code examples -If applicable, try to add executable code to and share the url to illustrate your point. e.g. https://go.dev/play/p/UfJNprdqDJ6 +If applicable, try to add executable code to and share the url to illustrate your point. e.g. [Go Playground](https://go.dev/play/p/UfJNprdqDJ6) ## What effort have you taken to solve this problem? From 0294dd76ad4174e8fa73f3d284abfece40dc3984 Mon Sep 17 00:00:00 2001 From: Ryan Maleki Date: Mon, 25 Nov 2024 23:18:46 -0800 Subject: [PATCH 10/11] add angle brackets --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 8c3f4dc..f2b37db 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -17,7 +17,7 @@ A clear and concise description of what you expected to happen. ## Running code examples -If applicable, try to add executable code to and share the url to illustrate your point. e.g. [Go Playground](https://go.dev/play/p/UfJNprdqDJ6) +If applicable, try to add executable code to and share the url to illustrate your point. e.g. . ## What effort have you taken to solve this problem? From 6c7b965b317496f712e1bfb38c375923dc1b34ff Mon Sep 17 00:00:00 2001 From: Ryan Maleki Date: Mon, 25 Nov 2024 23:22:35 -0800 Subject: [PATCH 11/11] s/url/URL --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f2b37db..185cf26 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -17,7 +17,7 @@ A clear and concise description of what you expected to happen. ## Running code examples -If applicable, try to add executable code to and share the url to illustrate your point. e.g. . +If applicable, try to add executable code to and share the URL to illustrate your point. e.g. . ## What effort have you taken to solve this problem?