Skip to content

Commit

Permalink
improve issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
thomas-mangin committed Mar 12, 2018
1 parent 685a36c commit eb77d02
Showing 1 changed file with 72 additions and 28 deletions.
100 changes: 72 additions & 28 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,101 @@
<!---
Verify first that your issue/request is not already reported on GitHub.
Also test if the latest release, and master branch are affected too.
Hello,
We are sorry that you are experiencing an issue with ExaBGP.
Before opening this issue could you please:
- make sure the problem was not already reported to avoid duplicates.
- check if the problem is still present on the latest version
using the 3.4 or master branch (if you know what it means)
alternatively the latest release (3.4 or 4.0)
For us to help you the outpout of exabgp -d is often required.
Please use ``` for any copied output.
-->

##### ISSUE TYPE
<!--- Pick one below and delete the rest: -->
- Bug Report
- Feature Idea
- Documentation Report
##### Summary
<!---
Explain the problem briefly
-->

##### OS
<!---
Mention the OS you are running ExaBGP on (Linux variant if relevant)
The exact OS would be appreciated (vendor and version)
(as OSes affect the way Python behave on some corner cases)
-->
```
Linux
MacOS
FreeBSD
Other (please specify)
```

<!--
the output of `uname -a`
-->
```
##### VERSION
<!--- Paste verbatim the output from “exabgp --version” between quotes below -->
```

##### Version
<!--
Paste verbatim the output from “exabgp --version” between quotes below
-->
```
##### ENVIRONMENT
<!--- Paste verbatim the output from “exabgp --di” (let us know if the output is empty) between quotes below -->
```

##### Installation
<!--
Please let us know how you installed ExaBGP
-->
```
pip
pip with virtualenv
latest OS package
other (please specify)
```

<!--- You can also use gist.github.com links for larger files -->
##### Environment
<!--
Paste verbatim the output from “exabgp --di” (let us know if the output is empty) between quotes below
You can also use gist.github.com links for larger files
-->

##### CONFIGURATION
<!--- Paste verbatim your configuration file
```
```

<!--- You can also use gist.github.com links for larger files -->
##### Configuration
<!---
Paste verbatim your configuration file
-->
```
##### SUMMARY
<!--- Explain the problem briefly -->
```

##### STEPS TO REPRODUCE
<!---
For bugs, please if possible, please run with the "-d" option and provide the full output,
If not possible, please provide the full fault section as reported by ExaBGP
##### Program output
<!--
When encountering a problem please run exabgp with the "-d" option
THIS IS THE MOST IMPORTANT INFORMATION - WITHOUT IT WE ARE UNLIKELY TO BE ABLE TO HELP
-->
```
```

##### EXPECTED RESULTS
<!--- What did you expect to happen when running the steps above? -->
##### Steps to reproduce
<!--
If the issue is intermittent please provide how it can be reproduced
-->
```
##### ACTUAL RESULTS
<!--- What actually happened? -->
```

##### IMPORTANCE
<!-- Please let us know if the issue is affecting you in a production environment -->
##### Importance
<!--
Please let us know if the issue is affecting you in a production environment
-->
```
```

0 comments on commit eb77d02

Please sign in to comment.