Skip to content

Commit

Permalink
Added issue template so hopefully issues are easier to understand and…
Browse files Browse the repository at this point in the history
… reproduce
  • Loading branch information
Ary Borenszweig committed Sep 1, 2016
1 parent 7fcae5a commit 76983c2
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Submitting bugs

Make sure to review these points before submitting issues - thank you!

- **Include reproducible code**: we should be able to paste it into an editor, compile and run it and get the same error as you. Otherwise it's impossible for us to reproduce the bug.
- Don't **only** use `play.crystal-lang.org` or `carc.in`: code might be lost and the issue will remain incomplete. Write code in the issue itself.
- Reduce code, if possible, to the minimum size that reproduces the bug.
- If all of the above is impossible due to a large project, create a branch that reproduces the bug and point us to it.
- Include Crystal compiler version (`crystal -v`) and OS. If possible, try to see if the bug still reproduces on master.

# Submitting questions

- If the question is something like "how do I do X?", consider using [StackOverflow](http://stackoverflow.com/questions/tagged/crystal-lang)
- If the question is about a shard, consider asking the question in that shard

0 comments on commit 76983c2

Please sign in to comment.