scapy/.github/ISSUE_TEMPLATE.md

39 lines
1.5 KiB
Markdown
Raw Normal View History

2018-04-14 18:34:09 +00:00
#### Things to consider
2018-10-20 23:33:21 +00:00
1. Please check that you are using the latest scapy version, e.g. installed via:
2018-04-14 18:34:09 +00:00
`pip install --upgrade git+git://github.com/secdev/scapy`
2018-04-14 18:34:09 +00:00
2018-10-20 23:33:21 +00:00
2. If you are here to ask a question - please check previous issues and online resources, and consider using gitter instead: <https://gitter.im/secdev/scapy>
2018-04-14 18:34:09 +00:00
2018-10-20 23:33:21 +00:00
3. Please understand that **this is not a forum** but an issue tracker. The following article explains why you should limit questions asked on Github issues: <https://medium.com/@methane/why-you-must-not-ask-questions-on-github-issues-51d741d83fde>
2018-04-14 18:34:09 +00:00
#### Brief description
2018-10-20 23:33:21 +00:00
> describe the main issue in one sentence
> if possible, describe what components / protocols could be affected by the issue (e.g. wrpcap() + IPv6, it is likely this also affects XXX)
2018-04-14 18:34:09 +00:00
#### Environment
2018-10-20 23:33:21 +00:00
- Scapy version: `scapy version and/or commit-hash`
- Python version: `e.g. 3.5`
- Operating System: `e.g. Minix 3.4`
2018-04-14 18:34:09 +00:00
2018-10-20 23:33:21 +00:00
> if needed - further information to get a picture of your setup (e.g. a sketch of your network setup)
2018-04-14 18:34:09 +00:00
#### How to reproduce
2018-10-20 23:33:21 +00:00
> step-by-step explanation or a short script, may reference section 'Related resources'
2018-04-14 18:34:09 +00:00
#### Actual result
2018-10-20 23:33:21 +00:00
> dump results that outline the issue, please format your code
2018-04-14 18:34:09 +00:00
#### Expected result
2018-10-20 23:33:21 +00:00
> describe the expected result and outline the difference to the actual one, could also be a screen shot (e.g. wireshark)
2018-04-14 18:34:09 +00:00
#### Related resources
2018-10-20 23:33:21 +00:00
> traces / sample pcaps (stripped to the relevant frames), related standards, RFCs or other resources