Skip to content

Improve the issue template. #787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 48 additions & 13 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,68 @@
<!--
<!-- CLICK "Preview" FOR INSTRUCTIONS IN A MORE READABLE FORMAT -->

## Prerequisites

- We realize there is a lot of data requested here. We ask only that you do your best to provide as much information as possible so we can better help you.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's nice that this is said explicitly 👍

- Read the [contributing guidelines](https://github.com/sindresorhus/ava/blob/master/contributing.md).
- Support questions are better asked in our [chat](https://gitter.im/sindresorhus/ava) or on [Stack Overflow](https://stackoverflow.com/questions/tagged/ava).
- Support questions are better asked in one of the following locations:
- [Our chat](https://gitter.im/sindresorhus/ava)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link has changed: https://gitter.im/avajs/ava

- [Stack Overflow](https://stackoverflow.com/questions/tagged/ava)
- Ensure the issue isn't already reported.
- Should be reproducible with the latest AVA version. (Ensure `ava --version` matches ![](https://img.shields.io/npm/v/ava.svg))
- Should be reproducible with the latest AVA version.
- (Ensure `ava --version` matches ![](https://img.shields.io/npm/v/ava.svg))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a HTML comment to tell them to remove this part when done.


-->
*Delete the above section and the instructions in the sections below before submitting*

## Description

<!--
If this is a feature request, explain why it should be added. Specific use cases are best.

Description of the issue.
For bug reports, please provide as much *relevant* info as possible.

If it's a feature request, include why it should be added.
### Test Source

-->
```js
// Avoid posting hundreds of lines of source code.
// Edit to just the relevant portions.
```

### Error Message & Stack Trace

## Environment
```
COPY THE ERROR MESSAGE, INCLUDING STACK TRACE HERE
```

<!--
### Config

Include the Node.js version and operating system. Run the following to get it quickly:
Copy the relevant section from `package.json`:

```json
{
"ava": {
...
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should automatically include this in the --report command

```
node -e "var os=require('os');console.log('Node.js ' + process.version + '\n' + os.platform() + ' ' + os.release())"

### Command Line Arguments

Copy your npm build scripts or the `ava` command used:

```
ava [OPTIONS HERE]
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This too, re --report


-->
## Relevant Links

- If your project is public, link to the repo so we can investigate directly.
- **BONUS POINTS:** Create a [minimal reproduction](http://stackoverflow.com/help/mcve) and upload it to GitHub. This will get you the fastest support.

## Environment

Tell us which operating system you are using, as well as which versions of Node.js, npm, and AVA. Run the following to get it quickly:

```
node -e "var os=require('os');console.log('Node.js ' + process.version + '\n' + os.platform() + ' ' + os.release())"
ava --version
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not really necessary as we already tell them to reproduce it with the latest version.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. But getting them to actually state "I'm running version XXX" eliminates one question-answer round. When trying to figure out the problem

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would include these in the above Environment snippet though.

npm --version
```