summaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 14:31:17 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 14:31:17 +0000
commit8020f71afd34d7696d7933659df2d763ab05542f (patch)
tree2fdf1b5447ffd8bdd61e702ca183e814afdcb4fc /.github/ISSUE_TEMPLATE
parentInitial commit. (diff)
downloadnetdata-upstream.tar.xz
netdata-upstream.zip
Adding upstream version 1.37.1.upstream/1.37.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/BUG_REPORT.yml102
-rw-r--r--.github/ISSUE_TEMPLATE/FEAT_REQUEST.yml62
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml12
3 files changed, 176 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml
new file mode 100644
index 0000000..d82d463
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml
@@ -0,0 +1,102 @@
+name: "Netdata Agent: Bug report"
+description: "Submit a report and help us improve our free and open-source Netdata Agent"
+title: "[Bug]: "
+labels: ["bug", "needs triage"]
+body:
+ - type: markdown
+ attributes:
+ value: "### Thank you for contributing to our project!"
+ - type: markdown
+ attributes:
+ value: |
+ <img src="https://img.shields.io/github/v/release/netdata/netdata.svg?label=latest%20stable"> <img src="https://img.shields.io/badge/dynamic/xml?url=https://storage.googleapis.com/netdata-nightlies/latest-version.txt&label=latest%20nightly&query=/text()">
+ - type: markdown
+ attributes:
+ value: |
+ Before submitting, we'd appreciate it if you:
+ - Verify that your issue is not already reported on GitHub.
+ - Check if your Netdata Agent is up to date. If not, we recommend that you [update](https://learn.netdata.cloud/docs/agent/packaging/installer/update) first.
+ - type: textarea
+ id: bug-description
+ attributes:
+ label: Bug description
+ description: Provide a description of the bug you're experiencing.
+ validations:
+ required: true
+ - type: textarea
+ id: expected-behavior
+ attributes:
+ label: Expected behavior
+ description: Describe what you expected to happen.
+ validations:
+ required: true
+ - type: textarea
+ id: reproduce
+ attributes:
+ label: Steps to reproduce
+ description: Describe the steps to reproduce the bug.
+ value: |
+ 1.
+ 2.
+ 3.
+ ...
+ validations:
+ required: true
+ - type: dropdown
+ id: install-method
+ attributes:
+ label: Installation method
+ description: |
+ Select [installation method](https://learn.netdata.cloud/docs/agent/packaging/installer#alternative-methods) you used.
+ Describe the method in the "Additional info" section if you chose "other".
+ options:
+ - "kickstart.sh"
+ - "kickstart-static64.sh"
+ - "native binary packages (.deb/.rpm)"
+ - "from git"
+ - "from source"
+ - "docker"
+ - "helmchart (kubernetes)"
+ - "other"
+ validations:
+ required: true
+ - type: textarea
+ id: system-info
+ attributes:
+ label: System info
+ description: |
+ Provide information about your system. To get this information, execute one of the following commands based on your OS:
+ ```shell
+ # Linux
+ uname -a; grep -HvE "^#|URL" /etc/*release
+ # BSD
+ uname -a; uname -K
+ # macOS
+ uname -a; sw_vers
+ ```
+ > NOTE: This will be automatically formatted into code, so no need for backticks.
+ render: shell
+ validations:
+ required: true
+ - type: textarea
+ id: netdata-buildfinfo
+ attributes:
+ label: Netdata build info
+ description: |
+ Provide Netdata Agent version and build info. To get this information, execute:
+ ```shell
+ netdata -W buildinfo
+ # If get "netdata: command not found", try (required running Netdata)
+ $(ps aux | grep -m1 -E -o "[a-zA-Z/]+netdata ") -W buildinfo
+ ```
+ > NOTE: This will be automatically formatted into code, so no need for backticks.
+ render: shell
+ validations:
+ required: true
+ - type: textarea
+ id: additional-info
+ attributes:
+ label: Additional info
+ description: Any additional information related to the issue (ex. logs).
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/FEAT_REQUEST.yml b/.github/ISSUE_TEMPLATE/FEAT_REQUEST.yml
new file mode 100644
index 0000000..11d77a0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/FEAT_REQUEST.yml
@@ -0,0 +1,62 @@
+name: "Netdata Agent: Feature request"
+description: "Submit a feature request and help us improve our free and open-source Netdata Agent"
+title: "[Feat]: "
+labels: ["feature request", "needs triage"]
+body:
+ - type: markdown
+ attributes:
+ value: "### Thank you for contributing to our project!"
+ - type: markdown
+ attributes:
+ value: |
+ Submit a feature request and help us improve our free and open-source Netdata Agent.
+ - type: textarea
+ id: problem
+ attributes:
+ label: Problem
+ description: |
+ Is your feature request intended to solve a problem? If so, provide a description of the problem.
+ validations:
+ required: false
+ - type: textarea
+ id: description
+ attributes:
+ label: Description
+ description: |
+ Provide a clear and concise description of the feature you want or need.
+ validations:
+ required: true
+ - type: dropdown
+ id: importance
+ attributes:
+ label: Importance
+ description: |
+ Help us to understand the importance of your feature request. Choose "blocker" if lack of this feature stops you from using Netdata Agent.
+ options:
+ - "nice to have"
+ - "really want"
+ - "must have"
+ - "blocker"
+ validations:
+ required: true
+ - type: textarea
+ id: value-proposition
+ attributes:
+ label: Value proposition
+ description: |
+ Help us to understand why we need this feaure. Describe benefits that users receive if we implement this feature request.
+ value: |
+ 1.
+ 2.
+ 3.
+ ...
+ validations:
+ required: true
+ - type: textarea
+ id: proposed-implementation
+ attributes:
+ label: Proposed implementation
+ description: |
+ Share your proposal if you have any ideas on how this feature can be implemented.
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..79678d7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,12 @@
+# Ref: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
+blank_issues_enabled: false
+contact_links:
+ - name: "Netdata Agent: Question"
+ url: https://github.com/netdata/netdata/discussions/new?category=q-a
+ about: Ask a question about Netdata Agent
+ - name: "Netdata Cloud"
+ url: https://github.com/netdata/netdata-cloud/issues/new/choose
+ about: Create a report to help us improve our web application
+ - name: Community
+ url: https://netdata.cloud/community
+ about: If you don't know where to start, visit our community page!