Skip to content

Commit

Permalink
chore: improvement to issue template (aws#4086)
Browse files Browse the repository at this point in the history
* chore: improvement to feature request issue template

1. Move description to the top, so it will be easier to skim through issues in mobile email clients.
2. Move "This is a feature request" to the bottom. It's not really needed since we have tags
3. Move "General Information" check boxes to "Other" at the end
4. Add "Use Case" to encourage people to describe WHY
5. Simplify and shorten instructions
6. Remove "Environment". It's usually not relevant for feature requests.

* Update bug.md

* Create doc.md

* Update bug.md

* Update bug.md

* Update feature-request.md

* wording clarification for "Proposed Solution"

previous wording was unclear as to direction
  • Loading branch information
Elad Ben-Israel authored and mergify[bot] committed Sep 17, 2019
1 parent bfbb300 commit 0f9a51e
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 57 deletions.
52 changes: 27 additions & 25 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,43 +4,45 @@ about: Report a bug
labels: bug, status/needs-triage
---

<!-- NOTE:📕 If issue regarding developer guide, please create issue [here](https://github.com/awsdocs/aws-cdk-guide/issues) -->

## :bug: Bug Report

### What is the problem?
<!--
Describe in as much detail as possible the problem that you have identified.
Please identify clearly what construct the problem relates to, or indicate
what part of the core cdk codebase is causing problems.
description of the bug:
-->




### Reproduction Steps
<!--
Whenever possible, add reference to the minimal reproduction of the issue, as
this will greatly help with identifying the root cause of the problem, and
ensuring a candidate fix is working.

If your minimal reprodiction is large, you may provide references to a [gist][1]
or any other publicly viewable location.
<!--
minimal amount of code that causes the bug (if possible) or a reference:
-->

### Verbose Log
<!--
If the output is very large, you may store it in a [gist][1]. In any case,
please review the contents of the log you are about to submit and edit any
confidential information out.

[1]: https://gist.github.com


### Error Log

<!--
what is the error message you are seeing?
-->




### Environment

- **CDK CLI Version:** <!-- Output of `cdk version` -->
- **Module Version:** <!-- Version of the module in question -->
- **OS:** <!-- [all | Windows 10 | OSX Mojave | Ubuntu | etc... ] -->
- **Language:** <!-- [all | TypeScript | Java | Python ] etc... ] -->
- **CLI Version :**
- **Framework Version:**
- **OS :**
- **Language :**

### Other

### Other information
<!-- e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. associated pull-request, stackoverflow, gitter, 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 or developer guide
labels: feature-request, status/needs-triage
---

<!--
- developer guide? raise issue/pr here: https://github.com/awsdocs/aws-cdk-guide
- want to help? submit a pull request here: https://github.com/aws/aws-cdk
-->

<!--
link to reference doc page:
-->



<!--
describe your issue:
-->





---

This is a 📕 documentation issue
61 changes: 29 additions & 32 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,45 +4,42 @@ about: Request a new feature
labels: feature-request, status/needs-triage
---

<!-- NOTE:📕 If issue regarding developer guide, please create issue [here](https://github.com/awsdocs/aws-cdk-guide/issues) -->
<!-- short description of the feature you are proposing: -->





### Use Case

<!-- why do you need this feature? -->


## :rocket: Feature Request

### General Information
<!--
Check the box below (with an X) if you are able and willing to propose an
implementation for the requested feature. This does not imply a commitment from
you to actually do it!
-->
* [ ] :wave: I may be able to implement this feature request
<!--
Check the box below (with an X) if you think this feature might result in a
breaking change (this requiring a major version bump when released). If unsure,
please leave the box un-checked.
-->
* [ ] :warning: This feature might incur a breaking change

### Description
<!--
Describe the feature you would like added in as much detail as you can. Make
sure you explain how it'll enhance the project, user-experience or feature set.
-->

### Proposed Solution
<!--
Whenever relevant, describe how you would like the feature to be implemented.
Include any documentation that can help understand your idea in very concrete
ways, such as code examples that leverage your feature, captures of design
diagrams, ...

<!-- Please include prototype/workaround/sketch/reference implementation: -->





### Other

<!--
e.g. detailed explanation, stacktraces, related issues, suggestions how to fix,
links for us to have context, eg. associated pull-request, stackoverflow, gitter, etc
-->

### Environment

- **CDK CLI Version:** <!-- Output of `cdk version` -->
- **Module Version:** <!-- Version of the module in question -->
- **OS:** <!-- [all | Windows 10 | OSX Mojave | Ubuntu | etc... ] -->
- **Language:** <!-- [all | TypeScript | Java | Python ] etc... ] -->


### Other information
<!-- e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. associated pull-request, stackoverflow, gitter, 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

0 comments on commit 0f9a51e

Please sign in to comment.