Commit f08e810

committed

chore: add pull request and issue templates

1 parent 79e930b commit f08e810Copy full SHA for f08e810

File tree

+167

-0

lines changed

+167

-0

lines changed

Lines changed: 51 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,51 @@`
	`1`	`+---`
	`2`	`+name: "\U0001F41B Bug Report"`
	`3`	`+about: Report a bug`
	`4`	`+title: "(module name): short issue description"`
	`5`	`+labels: bug, needs-triage`
	`6`	`+---`
	`7`	`+`
	`8`	`+<!--`
	`9`	`+description of the bug:`
	`10`	`+-->`
	`11`	`+`
	`12`	`+`
	`13`	`+`
	`14`	`+`
	`15`	`+### Reproduction Steps`
	`16`	`+`
	`17`	`+<!--`
	`18`	`+minimal amount of code that causes the bug (if possible) or a reference.`
	`19`	`+`
	`20`	`+The code sample should be an SSCCE. See http://sscce.org/ for details.`
	`21`	`+In short, provide a code sample that we can copy/paste, run and reproduce.`
	`22`	`+-->`
	`23`	`+`
	`24`	`+### What did you expect to happen?`
	`25`	`+`
	`26`	`+<!--`
	`27`	`+What were you trying to achieve by performing the steps above?`
	`28`	`+-->`
	`29`	`+`
	`30`	`+### What actually happened?`
	`31`	`+`
	`32`	`+<!--`
	`33`	`+What is the unexpected behavior you were seeing? If you got an error, paste it here.`
	`34`	`+-->`
	`35`	`+`
	`36`	`+`
	`37`	`+### Environment`
	`38`	`+`
	`39`	`+ - AWS Step Functions Data Science Python SDK version :`
	`40`	+ - Python Version: <!-- Version of Python (run the command `python3 --version`) -->
	`41`	`+`
	`42`	`+### Other`
	`43`	`+`
	`44`	`+<!-- e.g. detailed explanation, stack-traces, related issues, suggestions on how to fix, links for us to have context, eg. associated pull-request, stackoverflow, slack, etc -->`
	`45`	`+`
	`46`	`+`
	`47`	`+`
	`48`	`+`
	`49`	`+---`
	`50`	`+`
	`51`	`+This is :bug: Bug Report`

Lines changed: 28 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,28 @@`
	`1`	`+---`
	`2`	`+name: "📕 Documentation Issue"`
	`3`	`+about: Issue in the reference documentation`
	`4`	`+title: "(module name): short issue description"`
	`5`	`+labels: feature-request, documentation, needs-triage`
	`6`	`+---`
	`7`	`+`
	`8`	`+<!--`
	`9`	`+- want to help? submit a pull request! docs can be found here: https://github.com/aws/aws-step-functions-data-science-sdk-python/tree/main/doc`
	`10`	`+-->`
	`11`	`+`
	`12`	`+<!--`
	`13`	`+link to reference doc page:`
	`14`	`+-->`
	`15`	`+`
	`16`	`+`
	`17`	`+`
	`18`	`+<!--`
	`19`	`+describe your issue:`
	`20`	`+-->`
	`21`	`+`
	`22`	`+`
	`23`	`+`
	`24`	`+`
	`25`	`+`
	`26`	`+---`
	`27`	`+`
	`28`	`+This is a 📕 documentation issue`

Lines changed: 46 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,46 @@`
	`1`	`+---`
	`2`	`+name: "\U0001F680 Feature Request"`
	`3`	`+about: Request a new feature`
	`4`	`+title: "(module name): short issue description"`
	`5`	`+labels: feature-request, needs-triage`
	`6`	`+---`
	`7`	`+`
	`8`	`+<!-- short description of the feature you are proposing: -->`
	`9`	`+`
	`10`	`+`
	`11`	`+`
	`12`	`+`
	`13`	`+`
	`14`	`+### Use Case`
	`15`	`+`
	`16`	`+<!-- why do you need this feature? -->`
	`17`	`+`
	`18`	`+`
	`19`	`+`
	`20`	`+`
	`21`	`+`
	`22`	`+### Proposed Solution`
	`23`	`+`
	`24`	`+<!-- Please include prototype/workaround/sketch/reference implementation: -->`
	`25`	`+`
	`26`	`+`
	`27`	`+`
	`28`	`+`
	`29`	`+`
	`30`	`+### Other`
	`31`	`+`
	`32`	`+<!--`
	`33`	`+e.g. detailed explanation, stacktraces, related issues, suggestions on how to fix,`
	`34`	`+links for us to have context, eg. associated pull-request, stackoverflow, slack, etc`
	`35`	`+-->`
	`36`	`+`
	`37`	`+`
	`38`	`+`
	`39`	`+`
	`40`	`+`
	`41`	`+* [ ] :wave: I may be able to implement this feature request`
	`42`	`+* [ ] :warning: This feature might incur a breaking change`
	`43`	`+`
	`44`	`+---`
	`45`	`+`
	`46`	`+This is a :rocket: Feature Request`

Lines changed: 42 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,42 @@`
	`1`	`+### Description`
	`2`	`+`
	`3`	`+Please include a summary of the change being made.`
	`4`	`+`
	`5`	`+### Why is the change necessary?`
	`6`	`+* What capability does it enable?`
	`7`	`+* What problem does it solve?`
	`8`	`+`
	`9`	`+Fixes #(issue)`
	`10`	`+`
	`11`	`+### Solution`
	`12`	`+`
	`13`	`+Please include an overview of the solution. Discuss trade-offs made, caveats, alternatives, etc.`
	`14`	`+`
	`15`	`+### Testing`
	`16`	`+`
	`17`	`+How was this change tested?`
	`18`	`+`
	`19`	`+----`
	`20`	`+`
	`21`	`+### Pull Request Checklist`
	`22`	`+`
	`23`	`+Please check all boxes (including N/A items)`
	`24`	`+`
	`25`	`+#### Testing`
	`26`	`+`
	`27`	`+- [ ] Unit tests added`
	`28`	`+- [ ] integration test added`
	`29`	`+`
	`30`	`+#### Documentation`
	`31`	`+`
	`32`	`+- [ ] __docs__: All relevant [docs](https://github.com/aws/aws-step-functions-data-science-sdk-python/tree/main/doc) updated`
	`33`	`+- [ ] __docstrings__: All public APIs documented`
	`34`	`+`
	`35`	`+### Title and description`
	`36`	`+`
	`37`	`+- [ ] __Change type__: Title is prefixed with change type: and follows [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)`
	`38`	+- [ ] __References__: Indicate issues fixed via: `Fixes #xxx`
	`39`	`+`
	`40`	`+----`
	`41`	`+`
	`42`	`+By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.`

Comments

(0)