Skip to content

Commit 0b3a8ad

Browse files
committed
Add issue template to help people fill tickets
1 parent 91a25c1 commit 0b3a8ad

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

.github/ISSUE_TEMPLATE.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
### Pre-Check ###
2+
3+
- If you are filing for a bug, please do a quick search in current issues first
4+
- For bugs, mention if you are willing or interested in helping fix the issue
5+
- For questions or support, it helps to include context around your project or problem
6+
- Think of a descriptive title (more descriptive than 'feature X is broken' unless it is fully broken)
7+
8+
### Environment ###
9+
10+
- Add the result of `rebar3 report` to your message:
11+
12+
```
13+
$ rebar3 report "my failing command"
14+
...
15+
```
16+
17+
- Verify whether the version of rebar3 you're running is the latest release (see https://github.com/erlang/rebar3/releases)
18+
- If possible, include information about your project and its structure. Open source projects or examples are always easier to debug.
19+
If you can provide an example code base to reproduce the issue on, we will generally be able to provide more help, and faster.
20+
21+
### Current behaviour ###
22+
23+
Describe the current behaviour. In case of a failure, crash, or exception, please include the result of running the command with debug information:
24+
25+
```
26+
DEBUG=1 rebar3 <my failing command>
27+
```
28+
29+
### Expected behaviour ###
30+
31+
Describe what you expected to happen.

0 commit comments

Comments
 (0)