Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
a first bug report template
  • Loading branch information
srguiwiz committed Jun 23, 2018
1 parent b1f8bcb commit 8cd5f7a
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve

---

**Describe the bug**
A clear and concise description of what the bug is.

**Versions (please complete the following information):**
- Chokidar version [e.g. 2.0.4, or commit hash]
- Node version [e.g. 10.4.1]
- OS version: [e.g. Ubuntu 16.04, or Windows 10]

**To Reproduce**
Steps to reproduce the behavior.

Ideally prove a problem by isolating and making it reproducible with a very short sample program, which you could paste here:

```
var chokidar = require('chokidar');
var fs = require('fs');
// One-liner for files and directories starting with 'test'
chokidar.watch('test*', {}).on('all', (event, path) => {
console.log(event, path);
});
fs.writeFileSync('test.txt', 'testing 1');
// In a comment describe expected output versus observed problem
```

Most valuable could be one or more test cases for [test.js](https://github.com/paulmillr/chokidar/blob/master/test.js) to demonstrate the problem.

**Expected behavior**
A clear and concise description of what you expect to happen.

**Additional context**
Add any other context about the problem here.
Optionally nice to know what project you are working on.

0 comments on commit 8cd5f7a

Please sign in to comment.