Skip to content

Commit

Permalink
Add issue templates
Browse files Browse the repository at this point in the history
This adds issue templates so people can more easily provide everything we need to make something actionable.
  • Loading branch information
fhaynes authored Dec 30, 2018
1 parent cda6520 commit a5ccfda
Show file tree
Hide file tree
Showing 4 changed files with 120 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Bug Report
about: Found a bug? Create a report to help us improve!
title: "[BUG] Brief Description Here"
labels: 'status: needs triage, type: bug'
assignees: ''

---

## Description

A clear and concise description of what the bug is.

## Reproduction Steps

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## What You Expected to Happen

A clear and concise description of what you expected to happen.

## What Actually Happened

A clear and concise description of what actually happened.

## Screenshots

If applicable, add screenshots to help explain your problem.

## Your Environment

1. Operating System
2. Operating System Version
3. Version of Amethyst

## Additional Context
Add any other context about the problem here.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-modification-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Feature Modification Request
about: Have a suggestion to make an existing feature better? Let us know!
title: "[FEATURE MODIFICATION] Brief Description Here"
labels: 'status: needs triage, type: modification'
assignees: ''

---

## Feature

Which feature would you like to modify?

## Change

What change would you like to make to it?

## Reason

Why do you want to make this change?

## Impact

What impact would this change have? Do you think it would impact more features than just the one being modified?

## Additional Notes

Anything else relevant to add can go here
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/maintenance-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Maintenance Request
about: See something that isn't quite a bug, but could be made better? Use this!
title: "[MAINTENANCE] Brief Description Here"
labels: 'status: needs triage, type: maintenance'
assignees: ''

---

## Note

This type of request is for things like `unwrap()`s that snuck into production. They aren't likely to cause problems and aren't really a bug, but should be updated. Other examples include formatting updates, dependency updates, or code simplification.

## Description

What do you see that needs to be updated? Include a link to the code if possible.

## Reason

Why should this change be made?

## Impact

Do you think this change will have a negative impact on anything else?

## Additional Information

Any extra info you want to add can go here
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/new-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: New Feature Request
about: Suggest a new feature for this project
title: "[NEW FEATURE] Title Goes Here"
labels: 'status: needs triage, type: feature'
assignees: ''

---

## Description

Please note this is not for modifications to existing features. There is another Issue type for that. This is for proposing something that does not yet exist.

## What problem does this solve? What need does it fill?
A clear and concise description of what the problem/need is. Ex. I'm frustrated when I lose work due to a lack of auto-save.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

0 comments on commit a5ccfda

Please sign in to comment.