diff options
author | Zied Aouini <aouinizied@gmail.com> | 2021-10-13 18:39:10 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-10-13 18:39:10 +0200 |
commit | a2e9730b23bad7fea0047ac275786115f5912e84 (patch) | |
tree | 9c883bc0669d78656077d99e52822707a0d86b2e | |
parent | 937357e4bc55610f116f66d15a8e0fc1e260c02c (diff) |
Add issue templates. (#1340)
* Add issue template.
* Add config log instruction.
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_template.md | 50 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request_template.md | 20 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/question_template.md | 10 |
3 files changed, 80 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_template.md b/.github/ISSUE_TEMPLATE/bug_template.md new file mode 100644 index 000000000..5067d3168 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_template.md @@ -0,0 +1,50 @@ +--- +name: Bug Report +about: Create a report to help us improve nDPI +title: '' +labels: 'bug' +assignees: '' + +--- + + +## Describe the bug +A clear and concise description of what the bug is. + +### Expected behavior +A clear and concise description of what you expected to happen. +### Obtained behavior +A clear and concise description of what happening. + +## nDPI Environment (please complete the following information): +* OS name: [e.g. Ubuntu]. +* OS version: [e.g. 18.04] +* Architecture: [e.g. arm64] +* nDPI version or commit hash: [e.g. 4.0-stable or 937357e4bc55610f116f66d15a8e0fc1e260c02c]. +* nDPI compilation flags used: if you are building from source [e.g. --with-pcre --disable-gcrypt]. +* Attach the `config.log` file generated after `./configure` ran (if you are building from source). + +## How to reproduce the reported bug + +### Reproducible using ndpiReader? +- [x] The reported bug is reproducible using ndpiReader. +- [x] The reported bug is not reproducible using ndpiReader. + +### If applicable, the used ndpiReader options: + +``` shell +ndpiReader -q -t -i wlo1 -T 20 -U 20 +``` + +### If your bug is reproducible using a pcap, please attach a pcap file (or a valid link to download it) + +Example: test.pcap + +### Steps to reproduce the behavior: +1. Run '...' +2. Set '....' +3. Do '....' +4. See error + +## Additional context +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request_template.md b/.github/ISSUE_TEMPLATE/feature_request_template.md new file mode 100644 index 000000000..a5e8be675 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request_template.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea or a feature for nDPI +title: '' +labels: 'enhancement' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I always need to [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here.
\ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question_template.md b/.github/ISSUE_TEMPLATE/question_template.md new file mode 100644 index 000000000..1c74fbe03 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question_template.md @@ -0,0 +1,10 @@ +--- +name: General question +about: Ask a question about nDPI +title: '' +labels: 'question' +assignees: '' + +--- + +Type your question in a clear and concise way to help the community answering it.
\ No newline at end of file |