diff --git a/.github/ISSUE_TEMPLATE/blank.md b/.github/ISSUE_TEMPLATE/blank.md new file mode 100644 index 0000000000..88689a4175 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/blank.md @@ -0,0 +1,6 @@ +--- +name: Blank issue +about: Report a issue with no specific category +--- + +(A clear and concise description of the issue.) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000000..20a8822f27 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,103 @@ +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 + attributes: + label: "Operating systems tested on" + multiple: true + options: + - Linux + - macOS + - 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 + 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)" + multiple: true + options: + - libpcap + - PF_RING + - DPDK + - WinPcap + - Npcap + - XDP + - N/A + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..a281debaba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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/ " diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000000..1baa2487c3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,9 @@ +--- +name: Documentation +about: Report a problem with the documentation +labels: "documentation" +--- + +# Documentation + +(A clear and concise description of the issue.) diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000000..82539d7988 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,40 @@ +name: Question +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) + + - 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 + - Windows + - FreeBSD + - Android + - Other (specify in the question) + validations: + required: false