Skip to content

Commit

Permalink
docs: Issue templates for bug and feature requests (aws#726)
Browse files Browse the repository at this point in the history
  • Loading branch information
jfuss authored Dec 5, 2018
1 parent 1e8bd0b commit 9271ee7
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Bug report
about: Create an Issue to report a bug
---

<!-- Make sure we don't have an existing Issue that reports the bug you are seeing (both open and closed).
If you do find an existing Issue, re-open or add a comment to that Issue instead of creating a new one. -->

### Description

Briefly describe the bug you are facing.

### Steps to reproduce

Provide steps to replicate.

### Observed result

Please provide command output with `--debug` flag set.

### Expected result

Describe what you expected.

### Additional environment details (Ex: Windows, Mac, Amazon Linux etc)

1. OS:
2. `sam --version`:

`Add --debug flag to command you are running`
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Feature request
about: Suggest an idea/feature/enhancement
---

<!-- Make sure we don't have an existing Issue that reports the bug you are seeing (both open and closed). -->

### Describe your idea/feature/enhancement

Provide a clear description. Ex. I wish SAM CLI would [...]

### Proposal

Add details of how to add this to the product.

Things to consider:
1. Will this require any updates to the [SAM Spec](https://github.com/awslabs/serverless-application-model)

### Additional Details

0 comments on commit 9271ee7

Please sign in to comment.