Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 1.98 KB

ISSUE-TEMPLATE.md

File metadata and controls

78 lines (50 loc) · 1.98 KB

Working with and Submitting Issues

Existing Issues

When working with existing issues, you will need to keep a clear line of comments detailing what you are working on and how you plan to address the current issue.

If you are doing a PR or any commits, please make sure to reference the issue number in the respective commit or PR.

New Issues

When submitting a new issue, your headline should contain the following:

Issue Type: Issue Title

Example titles:
BUG: Routes don't work with Heroku
FEATURE: Add Heroku install script

For the issue body, your template will vary.

BUGS

Please use the following template:

### Prerequisites

* [ ] Can you reproduce the problem in safe mode?
* [ ] Are you running the latest version?
* [ ] Did you check the debugging guide?
* [ ] Did you check the FAQs on Discuss?
* [ ] Are you reporting to the correct repository?
* [ ] Did you perform a cursory search?

For more information, see the `CONTRIBUTING` guide.

### Description

[Description of the bug or feature]

### Steps to Reproduce

1. [First Step]
2. [Second Step]
3. [and so on...]

**Expected behavior:** [What you expected to happen]

**Actual behavior:** [What actually happened]

### Versions

You can get this information from executing `npm version`.

Pull Requests

Please use the following template:

## Types of changes

What types of changes does your code introduce? Put an `x` in all the boxes that apply:

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] I have read the **CONTRIBUTING** document.
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.

## Comments
Please add any comments here.