Skip to content

Commit

Permalink
Merge pull request #311 from u5surf/issue_template
Browse files Browse the repository at this point in the history
Add issue template
  • Loading branch information
u5surf authored Jan 5, 2025
2 parents dcb995a + f12ad50 commit b942dd8
Show file tree
Hide file tree
Showing 3 changed files with 137 additions and 0 deletions.
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Bug Report
description: Report incorrect behavior in this module
title: "BUG: "
labels: [bug]

body:
- type: checkboxes
id: checks
attributes:
label: module version checks
options:
- label: >
I have checked that this issue has not already been reported.
required: true
- type: textarea
id: problem
attributes:
label: Issue Description
description: >
Please provide a description of the issue shown in the reproducible example.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: >
Please describe or show a code example of the expected behavior.
validations:
required: true
- type: textarea
id: version
attributes:
label: Installed Versions
placeholder: >
% sudo /usr/local/nginx/sbin/nginx -V
nginx version: nginx/1.27.0
built by gcc 11.4.0 (Ubuntu 11.4.0-1ubuntu1~22.04)
configure arguments: --add-module=../nginx-module-vts
description: >
Please paste the output of ``nginx -V``
value: >
<details>
Replace this line with the output of nginx -V
</details>
validations:
required: true
- type: textarea
id: conf
attributes:
label: Reproducible Example nginx.conf
description: >
Please paste the reproducible nginx.conf
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Feature Request
description: Suggest an idea for this module
title: "ENH: "
labels: [enhancement]

body:
- type: checkboxes
id: checks
attributes:
label: Feature Type
description: Please check what type of feature request you would like to propose.
options:
- label: >
Adding new functionality to this module
- label: >
Changing existing functionality in this module
- label: >
Removing existing functionality in this module
- type: textarea
id: description
attributes:
label: Problem Description
description: >
Please describe what problem the feature would solve, e.g. "I wish I could use this module to ..."
placeholder: >
I wish I could use this module...
validations:
required: true
- type: textarea
id: feature
attributes:
label: Feature Description
description: >
Please describe how the new feature would be implemented, using psudocode if relevant.
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional Context
description: >
Please provide any relevant GitHub issues, code examples or references that help describe and support the feature request.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/submit_question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Submit Question
description: Ask a general question about this module
title: ""
labels: [question]

body:
- type: markdown
attributes:
value: ---
- type: textarea
id: question
attributes:
label: Question about this module
- type: textarea
id: version
attributes:
label: Installed Versions
placeholder: >
% sudo /usr/local/nginx/sbin/nginx -V
nginx version: nginx/1.27.0
built by gcc 11.4.0 (Ubuntu 11.4.0-1ubuntu1~22.04)
configure arguments: --add-module=../nginx-module-vts
description: >
Please paste the output of ``nginx -V``
value: >
<details>
Replace this line with the output of nginx -V
</details>
- type: textarea
id: conf
attributes:
label: Reproducible Example nginx.conf
description: >
Please paste the reproducible nginx.conf

0 comments on commit b942dd8

Please sign in to comment.