Skip to content

Commit

Permalink
chore: add pull request and issue templates (#164)
Browse files Browse the repository at this point in the history
Added in some templates for issues and a checklist for pull-requests, inspired by the CDK.

Issue templates:
These templates will be used for users who create Issues for the repo. Users will
be presented with options based on whether they are filing a feature-request, bug, or doc.

Pull request template:
This template will be applied whenever a pull request is opened
  • Loading branch information
shivlaks authored Oct 6, 2021
1 parent 23878de commit 58bed5d
Show file tree
Hide file tree
Showing 4 changed files with 168 additions and 0 deletions.
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
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
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/doc.md
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
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
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
43 changes: 43 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 58bed5d

Please sign in to comment.