Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Merge pull request #191 from sruggier/master
README.md: add a section about issue reporting
  • Loading branch information
cirosantilli committed May 24, 2015
2 parents e43bca7 + af5bd7c commit 81e1f07
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -37,3 +37,18 @@ If you wish to have a behavior that differs from that style guide, add an option
# Tests

All new features must have unit tests.

# Issues

Issues are tracked within GitHub.

When reporting issues, your report is more effective if you include a minimal example file that reproduces the problem. Try to trim out as much as possible, until you have the smallest possible file that still reproduces the issue. Paste the example inline into your issue report, quoted using four spaces at the beginning of each line, like this example from issue [#189](https://github.com/plasticboy/vim-markdown/issues/189):

```
Minimal example:
```
=
```
bad!
```

0 comments on commit 81e1f07

Please sign in to comment.