-
Notifications
You must be signed in to change notification settings - Fork 686
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
GitHub Issue template #1413
GitHub Issue template #1413
Changes from 14 commits
bc7cab7
8b57e45
c5d2fff
a3c8aa5
4c9cfdd
ce2a225
7f0f2b7
2f330e9
2cb04b7
20fdbce
6a12198
818334d
f418769
b716f25
54ab06a
81fa25c
c703c23
28bf610
9ec5e96
6ee3e92
f5cf47d
d0600df
454a892
8d5c0fd
31a6216
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
name: Blank issue | ||
about: Report a issue with no specific category | ||
--- | ||
|
||
(A clear and concise description of the issue.) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
name: Bug report | ||
description: Submit a bug report | ||
labels: ["bug"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
**New to PcapPlusPlus?** | ||
|
||
For help or advice on using PcapPlusPlus, try one of the following options instead of opening a GitHub issue: | ||
|
||
- Post a message in PcapPlusPlus Google group: https://groups.google.com/d/forum/pcapplusplus-support | ||
- Ask a question on Stack Overflow: https://stackoverflow.com/questions/tagged/pcapplusplus | ||
- Send an email to: pcapplusplus@gmail.com | ||
- Follow us on Twitter: https://twitter.com/seladb | ||
|
||
Make sure to also search the [PcapPlusPlus issue tracker](https://github.com/seladb/PcapPlusPlus/issues) to check that the bug has not already been reported. | ||
|
||
You can check more information about how to report a bug in the [PcapPlusPlus page](https://pcapplusplus.github.io/community#report-an-issue). | ||
- type: textarea | ||
attributes: | ||
label: "Bug description:" | ||
description: > | ||
Give a clear and concise description of what happened. | ||
Include a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) if possible. | ||
[Copy and paste code where possible rather than using screenshots](https://meta.stackoverflow.com/a/285557/13990016), | ||
and put any code blocks inside triple backticks. | ||
|
||
value: | | ||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**Code example to reproduce** | ||
```cpp | ||
// Add a code block here, if required | ||
``` | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
validations: | ||
required: true | ||
- type: dropdown | ||
attributes: | ||
label: "PcapPlusPlus versions tested on:" | ||
multiple: true | ||
options: | ||
- "PcapPlusPlus master branch" | ||
- "v23.09" | ||
- "v22.11" | ||
- "v22.05" | ||
- "v21.11" | ||
- "v21.05" | ||
- "Other (specify in the next question)" | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Other PcapPlusPlus version (if applicable): | ||
description: If you select "Other", please specify the version of PcapPlusPlus you tested on. | ||
placeholder: ex. Build with commit hash 1234567 | ||
validations: | ||
required: false | ||
- type: dropdown | ||
egecetin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
attributes: | ||
label: "Operating systems tested on:" | ||
multiple: true | ||
options: | ||
- Linux | ||
- macOS | ||
tigercosmos marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Windows | ||
- FreeBSD | ||
- Android | ||
- Other (specify in the next question) | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Other operation systems (if applicable): | ||
description: If you select "Other", please specify the operation system you tested on. | ||
placeholder: ex. ChromeOS, Solaris | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We could also add the architecture if it's ARM64 or AMD64 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I am wondering was there any bug related to the architecture before? so far I didn't see any? |
||
validations: | ||
required: false | ||
- type: input | ||
attributes: | ||
label: Compiler version: | ||
description: Please specify the compiler version you used. | ||
placeholder: ex. GCC 10.2.0 | ||
validations: | ||
required: true | ||
- type: dropdown | ||
attributes: | ||
label: Packet capture backend (if applicable): | ||
Dimi1010 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
multiple: true | ||
options: | ||
egecetin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- libpcap | ||
- PF_RING | ||
- DPDK | ||
- WinPcap | ||
- Npcap | ||
- XDP | ||
- N/A | ||
validations: | ||
egecetin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
required: false |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
contact_links: | ||
- name: "Contact the PcapPlusPlus team" | ||
about: "For help or advice on using PcapPlusPlus, try one of the following options instead of opening a GitHub issue:" | ||
url: "https://pcapplusplus.github.io/community" | ||
- name: "Documentation" | ||
about: "Check the PcapPlusPlus documentation for more information." | ||
url: "https://pcapplusplus.github.io/docs/quickstart" | ||
seladb marked this conversation as resolved.
Show resolved
Hide resolved
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
name: Documentation | ||
about: Report a problem with the documentation | ||
labels: "documentation" | ||
--- | ||
|
||
# Documentation | ||
|
||
(A clear and concise description of the issue.) |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,40 @@ | ||||||
name: Question | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd add a platform option here as well (could be optional). In many cases questions are for specific platforms There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. added |
||||||
description: Submit a question | ||||||
labels: ["question"] | ||||||
body: | ||||||
- type: markdown | ||||||
attributes: | ||||||
value: | | ||||||
# Asking a question | ||||||
If you have a question about PcapPlusPlus, please check the following resources before opening a new issue: | ||||||
- [PcapPlusPlus documentation](https://pcapplusplus.github.io/docs/quickstart) | ||||||
- [PcapPlusPlus API reference](https://pcapplusplus.github.io/docs/api) | ||||||
- [GIthub issues tracker](https://github.com/seladb/PcapPlusPlus/issues) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks, let me correct to "GitHub", which is the correct one. |
||||||
|
||||||
- type: textarea | ||||||
attributes: | ||||||
label: "Question:" | ||||||
description: > | ||||||
Explain your question in detail. | ||||||
value: | | ||||||
```cpp | ||||||
# Add a code block here, if required | ||||||
``` | ||||||
validations: | ||||||
required: true | ||||||
|
||||||
- type: dropdown | ||||||
attributes: | ||||||
label: "Operating systems:" | ||||||
description: > | ||||||
Select the operating systems that you are interested in. | ||||||
multiple: true | ||||||
options: | ||||||
- Linux | ||||||
- macOS | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. macOS is the correct spelling, please see https://en.wikipedia.org/wiki/MacOS |
||||||
- Windows | ||||||
- FreeBSD | ||||||
- Android | ||||||
- Other (specify in the question) | ||||||
validations: | ||||||
required: false |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: maybe remove the
:
character in the end of all labels?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@seladb I followed the CPython style, but sure, let me change it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed.