-
Notifications
You must be signed in to change notification settings - Fork 90
chore: add pull request and issue templates #164
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
f08e810
chore: add pull request and issue templates
shivlaks 2b33355
minor tweaks, get rid of module references
shivlaks e79e4eb
lowercase pull request template filename
shivlaks a2a0b6b
PR feedback
shivlaks 0485f7e
pr feedback
shivlaks 194c0f7
capitalize category
shivlaks 5cf32a8
Merge branch 'main' into shivlaks/pr-issue-templates
shivlaks File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
name: "\U0001F41B Bug Report" | ||
about: Report a bug | ||
title: "short issue description" | ||
labels: bug, needs-triage | ||
--- | ||
|
||
<!-- | ||
description of the bug: | ||
--> | ||
|
||
|
||
|
||
|
||
### Reproduction Steps | ||
|
||
<!-- | ||
minimal amount of code that causes the bug (if possible) or a reference. | ||
|
||
The code sample should be an SSCCE. See http://sscce.org/ for details. | ||
In short, provide a code sample that we can copy/paste, run and reproduce. | ||
--> | ||
|
||
### What did you expect to happen? | ||
|
||
<!-- | ||
What were you trying to achieve by performing the steps above? | ||
--> | ||
|
||
### What actually happened? | ||
|
||
<!-- | ||
What is the unexpected behavior you were seeing? If you got an error, paste it here. | ||
--> | ||
|
||
|
||
### Environment | ||
|
||
- **AWS Step Functions Data Science Python SDK version :** | ||
- **Python Version:** <!-- Version of Python (run the command `python3 --version`) --> | ||
|
||
### Other | ||
|
||
<!-- 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 --> | ||
|
||
|
||
|
||
|
||
--- | ||
|
||
This is :bug: Bug Report |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
name: "📕 Documentation Issue" | ||
about: Issue in the reference documentation | ||
title: "short issue description" | ||
labels: feature-request, documentation, needs-triage | ||
--- | ||
|
||
<!-- | ||
- 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 | ||
--> | ||
|
||
<!-- | ||
link to reference doc page: | ||
--> | ||
|
||
|
||
|
||
<!-- | ||
describe your issue: | ||
--> | ||
|
||
|
||
|
||
|
||
|
||
--- | ||
|
||
This is a 📕 documentation issue |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
name: "\U0001F680 Feature Request" | ||
about: Request a new feature | ||
title: "short issue description" | ||
labels: feature-request, needs-triage | ||
--- | ||
|
||
<!-- short description of the feature you are proposing: --> | ||
|
||
|
||
|
||
|
||
|
||
### Use Case | ||
|
||
<!-- why do you need this feature? --> | ||
|
||
|
||
|
||
|
||
|
||
### Proposed Solution | ||
|
||
<!-- Please include prototype/workaround/sketch/reference implementation: --> | ||
|
||
|
||
|
||
|
||
|
||
### Other | ||
|
||
<!-- | ||
e.g. detailed explanation, stacktraces, related issues, suggestions on how to fix, | ||
links for us to have context, eg. associated pull-request, stackoverflow, slack, etc | ||
--> | ||
|
||
|
||
|
||
|
||
|
||
* [ ] :wave: I may be able to implement this feature request | ||
* [ ] :warning: This feature might incur a breaking change | ||
|
||
--- | ||
|
||
This is a :rocket: Feature Request |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
### 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 | ||
shivlaks marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
shivlaks marked this conversation as resolved.
Show resolved
Hide resolved
|
||
#### 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/) | ||
shivlaks marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- [ ] __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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.