Skip to content

Commit

Permalink
github: add issue templates
Browse files Browse the repository at this point in the history
It formalize feedback from users.

Signed-off-by: Kentaro Hayashi <[email protected]>
  • Loading branch information
kenhys committed Jan 8, 2025
1 parent 69f5408 commit 8b1cd43
Show file tree
Hide file tree
Showing 3 changed files with 107 additions and 0 deletions.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Bug Report
description: Create a report with a procedure for reproducing the bug
labels: "waiting-for-triage"
body:
- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: To Reproduce
description: Steps to reproduce the behavior
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen
validations:
required: true
- type: textarea
id: environment
attributes:
label: Your Environment
description: |
- Fluentd or its package version: `fluentd --version` (Fluentd, fluent-package) or `td-agent --version` (td-agent)
- Operating system: `cat /etc/os-release`
- Kernel version: `uname -r`
Tip: If you hit the problem with older fluent-plugin-systemd version, try latest version first.
value: |
- Fluentd version:
- Package version:
- Operating system:
- Kernel version:
render: markdown
validations:
required: true
- type: textarea
id: configuration
attributes:
label: Your Configuration
description: |
Write your configuration here. Minimum reproducible fluentd.conf is recommended.
render: apache
validations:
required: true
- type: textarea
id: logs
attributes:
label: Your Error Log
description: Write your ALL error log here
render: shell
validations:
required: true
- type: textarea
id: addtional-context
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Ask a Question
url: https://github.com/fluent/fluentd/discussions
about: I have questions about Fluentd and plugins. Please ask and answer questions at https://github.com/fluent/fluentd/discussions
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Feature request
description: Suggest an idea for this project
labels: ["waiting-for-triage", "enhancement"]
body:
- type: textarea
id: description
attributes:
label: Is your feature request related to a problem? Please describe.
description: |
A clear and concise description of what the problem is.
Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: alternative
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: true
- type: textarea
id: addtional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false

0 comments on commit 8b1cd43

Please sign in to comment.