GitHub Issue template #1413

tigercosmos · 2024-05-29T06:45:33Z

Added GitHub issue template. fix #1407

The demos are as follows:

.github/ISSUE_TEMPLATE/bug.yml

…into issue_template

.github/ISSUE_TEMPLATE/bug.yml

seladb · 2024-05-29T08:20:23Z

.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,24 @@
+name: Question


I'd add a platform option here as well (could be optional). In many cases questions are for specific platforms

seladb · 2024-05-29T08:21:17Z

.github/ISSUE_TEMPLATE/bug.yml

+      value: |
+        ```cpp
+        # Add a code block here, if required
+        ```


Should we add a bug report template with specific questions people need to answer to make the bug report more structured?

I think we already cover most of the questions that we are interested in, e.g. version, compiler, OS, etc.

Perhaps we can also add a section for backtrace, or error log, but I think these don't have to be a standalone question.

People should be able to add more information in the "description" section.

Do you have specific questions want to add to the template?

Currently the bug description only includes a template for C++ code:

When I first looked at it I thought I only need to fill out the code example, and I searched where can I write the bug description 🙂

I just opened a bug in Npcap and their template is quite nice, although we need different topics:
https://github.com/nmap/npcap/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=

Maybe:

**Describe the bug** A clear and concise description of what the bug is. **Code example to reproduce** (code template) **Expected behavior** A clear and concise description of what you expected to happen.

Okay, I will apply your suggestion, but I would prevent putting too many words inside, most of the time, I also ignore those "templates" when I submit issues in other projects. If we put too much stuff, people will just feel annoyed and ignore it.

tigercosmos · 2024-05-30T02:04:57Z

@seladb I guess this is ready for merge.

seladb · 2024-05-30T07:38:03Z

@clementperon @egecetin @Dimi1010 let me know when this PR is LGTM

I'll also take a look

egecetin · 2024-05-30T08:06:41Z

.github/ISSUE_TEMPLATE/black.md

@@ -0,0 +1,6 @@
+---


Filename should black.md or blank.md? Maybe a typo

ops, thanks!!

egecetin

Only left one comment. I'm not sure is a typo or not.

Dimi1010 · 2024-05-30T09:01:14Z

@tigercosmos can you merge https://github.com/tigercosmos/PcapPlusPlus/tree/issue_template to https://github.com/tigercosmos/PcapPlusPlus/tree/master so it'll be easier to test the different issues types?

done, you can check now

The bug report template has an issue

seladb · 2024-05-30T09:01:55Z

.github/ISSUE_TEMPLATE/bug.yml

+      required: true
+  - type: dropdown
+    attributes:
+      label: "PcapPlusPlus versions tested on:"


nit: maybe remove the : character in the end of all labels?

@seladb I followed the CPython style, but sure, let me change it.

.github/ISSUE_TEMPLATE/bug.yml

…into issue_template

clementperon · 2024-05-30T12:22:15Z

.github/ISSUE_TEMPLATE/question.yml

+      multiple: true
+      options:
+        - Linux
+        - macOS


Suggested change

- macOS

- MacOS

macOS is the correct spelling, please see https://en.wikipedia.org/wiki/MacOS

clementperon · 2024-05-30T12:22:46Z

.github/ISSUE_TEMPLATE/question.yml

+        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)


Suggested change

- [GIthub issues tracker](https://github.com/seladb/PcapPlusPlus/issues)

- [Github issues tracker](https://github.com/seladb/PcapPlusPlus/issues)

Thanks, let me correct to "GitHub", which is the correct one.

.github/ISSUE_TEMPLATE/bug.yml

clementperon · 2024-05-30T12:23:50Z

.github/ISSUE_TEMPLATE/bug.yml

+    attributes:
+      label: "Other operation systems (if applicable):"
+      description: If you select "Other", please specify the operation system you tested on.
+      placeholder: ex. ChromeOS, Solaris


We could also add the architecture if it's ARM64 or AMD64

I am wondering was there any bug related to the architecture before? so far I didn't see any?

tigercosmos · 2024-05-31T01:11:34Z

@seladb all issues addressed. please have a look.

seladb · 2024-05-31T05:59:29Z

@tigercosmos I believe only this one is left: #1413 (comment)

tigercosmos · 2024-05-31T08:01:23Z

@seladb should all clear.

seladb · 2024-05-31T08:24:27Z

@seladb should all clear.

@tigercosmos can you merge this branch to your fork's master branch so I can review it one last time?

tigercosmos · 2024-05-31T09:11:21Z

@seladb here you go.

@seladb should all clear.

@tigercosmos can you merge this branch to your fork's master branch so I can review it one last time?

tigercosmos added 2 commits May 29, 2024 15:44

add github issue template

bc7cab7

update

8b57e45

tigercosmos requested a review from seladb as a code owner May 29, 2024 06:45

tigercosmos requested review from clementperon, Dimi1010 and egecetin May 29, 2024 06:46

tigercosmos changed the base branch from master to dev May 29, 2024 06:47

Merge branch 'dev' into issue_template

c5d2fff

egecetin reviewed May 29, 2024

View reviewed changes

.github/ISSUE_TEMPLATE/bug.yml Show resolved Hide resolved

.github/ISSUE_TEMPLATE/bug.yml Show resolved Hide resolved

Dimi1010 reviewed May 29, 2024

View reviewed changes

.github/ISSUE_TEMPLATE/bug.yml Outdated Show resolved Hide resolved

tigercosmos added 4 commits May 29, 2024 16:22

add input for "Other"

a3c8aa5

Merge branch 'issue_template' of github.com:tigercosmos/PcapPlusPlus …

4c9cfdd

…into issue_template

add compiler & packet capture backend

ce2a225

minor change

7f0f2b7

seladb reviewed May 29, 2024

View reviewed changes

tigercosmos added 5 commits May 29, 2024 17:31

xdp

2f330e9

add Operating systems for question

2cb04b7

update

20fdbce

update

6a12198

indent

818334d

seladb requested review from Dimi1010 and egecetin May 30, 2024 07:38

egecetin reviewed May 30, 2024

View reviewed changes

egecetin approved these changes May 30, 2024

View reviewed changes

fix typo

f418769

egecetin approved these changes May 30, 2024

View reviewed changes

Merge branch 'dev' into issue_template

b716f25

tigercosmos requested a review from seladb May 30, 2024 08:11

tigercosmos and others added 2 commits May 30, 2024 17:59

link

54ab06a

Merge branch 'dev' into issue_template

81fa25c

seladb reviewed May 30, 2024

View reviewed changes

Dimi1010 reviewed May 30, 2024

View reviewed changes

.github/ISSUE_TEMPLATE/bug.yml Outdated Show resolved Hide resolved

tigercosmos added 6 commits May 30, 2024 18:02

update

c703c23

update

28bf610

fix

9ec5e96

Merge branch 'issue_template' of github.com:tigercosmos/PcapPlusPlus …

6ee3e92

…into issue_template

Merge branch 'issue_template'

f5cf47d

fix

d0600df

clementperon reviewed May 30, 2024

View reviewed changes

.github/ISSUE_TEMPLATE/bug.yml Show resolved Hide resolved

clementperon reviewed May 30, 2024

View reviewed changes

clementperon approved these changes May 30, 2024

View reviewed changes

fix typo

454a892

tigercosmos requested a review from seladb May 31, 2024 01:11

tigercosmos enabled auto-merge (squash) May 31, 2024 04:56

update

8d5c0fd

Merge branch 'dev' into issue_template

31a6216

seladb approved these changes Jun 2, 2024

View reviewed changes

tigercosmos merged commit da1ef60 into seladb:dev Jun 2, 2024
39 checks passed

tigercosmos deleted the issue_template branch June 2, 2024 09:20

egecetin mentioned this pull request Jun 2, 2024

Introduce GitHub issue template #1407

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Issue template #1413

GitHub Issue template #1413

tigercosmos commented May 29, 2024 •

edited

Loading

seladb May 29, 2024

tigercosmos May 29, 2024

seladb May 29, 2024

tigercosmos May 29, 2024

seladb May 29, 2024

tigercosmos May 29, 2024

tigercosmos May 29, 2024

tigercosmos commented May 30, 2024

seladb commented May 30, 2024

egecetin May 30, 2024

tigercosmos May 30, 2024

egecetin left a comment

Dimi1010 commented May 30, 2024

seladb May 30, 2024

tigercosmos May 31, 2024

tigercosmos May 31, 2024

clementperon May 30, 2024

tigercosmos May 30, 2024

clementperon May 30, 2024

tigercosmos May 30, 2024

clementperon May 30, 2024

tigercosmos May 30, 2024

tigercosmos commented May 31, 2024

seladb commented May 31, 2024

tigercosmos commented May 31, 2024

seladb commented May 31, 2024

tigercosmos commented May 31, 2024

	- [GIthub issues tracker](https://github.com/seladb/PcapPlusPlus/issues)
	- [Github issues tracker](https://github.com/seladb/PcapPlusPlus/issues)

GitHub Issue template #1413

GitHub Issue template #1413

Conversation

tigercosmos commented May 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tigercosmos commented May 30, 2024

seladb commented May 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

egecetin left a comment

Choose a reason for hiding this comment

Dimi1010 commented May 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tigercosmos commented May 31, 2024

seladb commented May 31, 2024

tigercosmos commented May 31, 2024

seladb commented May 31, 2024

tigercosmos commented May 31, 2024

tigercosmos commented May 29, 2024 •

edited

Loading