From f08e8108ed6e3ac20292327135f319e7a15a23a8 Mon Sep 17 00:00:00 2001 From: Shiv Lakshminarayan Date: Sat, 11 Sep 2021 01:14:15 -0700 Subject: [PATCH 1/6] chore: add pull request and issue templates --- .github/ISSUE_TEMPLATE/bug.md | 51 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/doc.md | 28 +++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 46 ++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 42 +++++++++++++++++++ 4 files changed, 167 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/doc.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..5c84e20 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,51 @@ +--- +name: "\U0001F41B Bug Report" +about: Report a bug +title: "(module name): short issue description" +labels: bug, needs-triage +--- + + + + + + +### Reproduction Steps + + + +### What did you expect to happen? + + + +### What actually happened? + + + + +### Environment + + - **AWS Step Functions Data Science Python SDK version :** + - **Python Version:** + +### Other + + + + + + +--- + +This is :bug: Bug Report \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/doc.md b/.github/ISSUE_TEMPLATE/doc.md new file mode 100644 index 0000000..365f05e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/doc.md @@ -0,0 +1,28 @@ +--- +name: "📕 Documentation Issue" +about: Issue in the reference documentation +title: "(module name): short issue description" +labels: feature-request, documentation, needs-triage +--- + + + + + + + + + + + + + +--- + +This is a 📕 documentation issue diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..163f2f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,46 @@ +--- +name: "\U0001F680 Feature Request" +about: Request a new feature +title: "(module name): short issue description" +labels: feature-request, needs-triage +--- + + + + + + + +### Use Case + + + + + + + +### Proposed Solution + + + + + + + +### Other + + + + + + + +* [ ] :wave: I may be able to implement this feature request +* [ ] :warning: This feature might incur a breaking change + +--- + +This is a :rocket: Feature Request diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..29caeb4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,42 @@ +### Description + +Please include a summary of the change being made. + +### Why is the change necessary? +* What capability does it enable? +* What problem does it solve? + +Fixes #(issue) + +### Solution + +Please include an overview of the solution. Discuss trade-offs made, caveats, alternatives, etc. + +### Testing + +How was this change tested? + +---- + +### Pull Request Checklist + +Please check all boxes (including N/A items) + +#### Testing + +- [ ] Unit tests added +- [ ] integration test added + +#### Documentation + +- [ ] __docs__: All relevant [docs](https://github.com/aws/aws-step-functions-data-science-sdk-python/tree/main/doc) updated +- [ ] __docstrings__: All public APIs documented + +### Title and description + +- [ ] __Change type__: Title is prefixed with change type: and follows [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) +- [ ] __References__: Indicate issues fixed via: `Fixes #xxx` + +---- + +By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice. From 2b33355dc26e625228826d06f820f0766179bc2e Mon Sep 17 00:00:00 2001 From: Shiv Lakshminarayan Date: Sat, 11 Sep 2021 01:29:00 -0700 Subject: [PATCH 2/6] minor tweaks, get rid of module references --- .github/ISSUE_TEMPLATE/bug.md | 2 +- .github/ISSUE_TEMPLATE/doc.md | 2 +- .github/ISSUE_TEMPLATE/feature-request.md | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 5c84e20..6f68eb1 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -1,7 +1,7 @@ --- name: "\U0001F41B Bug Report" about: Report a bug -title: "(module name): short issue description" +title: "short issue description" labels: bug, needs-triage --- diff --git a/.github/ISSUE_TEMPLATE/doc.md b/.github/ISSUE_TEMPLATE/doc.md index 365f05e..931e8ac 100644 --- a/.github/ISSUE_TEMPLATE/doc.md +++ b/.github/ISSUE_TEMPLATE/doc.md @@ -1,7 +1,7 @@ --- name: "📕 Documentation Issue" about: Issue in the reference documentation -title: "(module name): short issue description" +title: "short issue description" labels: feature-request, documentation, needs-triage --- diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 163f2f5..5570a1b 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -1,7 +1,7 @@ --- name: "\U0001F680 Feature Request" about: Request a new feature -title: "(module name): short issue description" +title: "short issue description" labels: feature-request, needs-triage --- diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 29caeb4..6a46245 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,11 +2,11 @@ Please include a summary of the change being made. +Fixes #(issue) + ### Why is the change necessary? -* What capability does it enable? -* What problem does it solve? -Fixes #(issue) +What capability does it enable? What problem does it solve? ### Solution @@ -39,4 +39,4 @@ Please check all boxes (including N/A items) ---- -By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice. +By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license. From e79e4ebe094d9fd2fd4d28b666b4366b4e71412d Mon Sep 17 00:00:00 2001 From: Shiv Lakshminarayan Date: Sat, 11 Sep 2021 01:32:28 -0700 Subject: [PATCH 3/6] lowercase pull request template filename --- .github/{PULL_REQUEST_TEMPLATE.md => pull_request_template.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/{PULL_REQUEST_TEMPLATE.md => pull_request_template.md} (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/pull_request_template.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE.md rename to .github/pull_request_template.md From a2a0b6b11d485d6a49e3c6d9ca14c537544faf74 Mon Sep 17 00:00:00 2001 From: Shiv Lakshminarayan Date: Wed, 29 Sep 2021 15:08:16 -0400 Subject: [PATCH 4/6] PR feedback Co-authored-by: Adam Wong <55506708+wong-a@users.noreply.github.com> --- .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 6a46245..c059bc9 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -25,7 +25,7 @@ Please check all boxes (including N/A items) #### Testing - [ ] Unit tests added -- [ ] integration test added +- [ ] Integration test added #### Documentation From 0485f7e0c6b3da9f8d2224fd5ab5d061363169f5 Mon Sep 17 00:00:00 2001 From: Shiv Lakshminarayan Date: Tue, 5 Oct 2021 11:18:36 -0400 Subject: [PATCH 5/6] pr feedback --- .github/pull_request_template.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c059bc9..2ab62b3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -26,6 +26,7 @@ Please check all boxes (including N/A items) - [ ] Unit tests added - [ ] Integration test added +- [ ] manual testing - why was it necessary? could it be automated? #### Documentation From 194c0f76ed090e9a99e88cf13c30508e4295013a Mon Sep 17 00:00:00 2001 From: Shiv Lakshminarayan Date: Tue, 5 Oct 2021 11:22:23 -0400 Subject: [PATCH 6/6] capitalize category --- .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 2ab62b3..3f06f79 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -26,7 +26,7 @@ Please check all boxes (including N/A items) - [ ] Unit tests added - [ ] Integration test added -- [ ] manual testing - why was it necessary? could it be automated? +- [ ] Manual testing - why was it necessary? could it be automated? #### Documentation