diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..6f68eb1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,51 @@ +--- +name: "\U0001F41B Bug Report" +about: Report a bug +title: "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..931e8ac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/doc.md @@ -0,0 +1,28 @@ +--- +name: "π Documentation Issue" +about: Issue in the reference documentation +title: "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..5570a1b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,46 @@ +--- +name: "\U0001F680 Feature Request" +about: Request a new feature +title: "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..3f06f79 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,43 @@ +### Description + +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? + +### 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 +- [ ] Manual testing - why was it necessary? could it be automated? + +#### 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 my contribution is made under the terms of the Apache-2.0 license.