diff options
Diffstat (limited to '.github/ISSUE_TEMPLATE')
| -rw-r--r-- | .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 102 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 72 |
2 files changed, 102 insertions, 72 deletions
diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml new file mode 100644 index 000000000..10a131c4c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -0,0 +1,102 @@ +name: "Bug report: Netdata" +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/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 799fba7a0..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -name: "Bug report: Netdata Agent" -about: "Submit a report and help us improve our free and open-source Netdata Agent" -labels: bug, needs triage ---- - -<!-- -When creating a bug report please: -- Verify first that your issue is not already reported on GitHub. -- Test if the latest release and master branch are affected too. ---> - -##### Bug report summary - -<!-- Provide a clear and concise description of the bug you're experiencing. --> - -##### OS / Environment - -<!-- -Provide as much information about your environment (which operating system and distribution you're using, if Netdata is running in a container, etc.) -as possible to allow us reproduce this bug faster. - -To get this information, execute the following commands based on your operating system: -- uname -a; grep -Hv "^#" /etc/*release # Linux -- uname -a; uname -K # BSD -- uname -a; sw_vers # macOS - -Place the output from the command in the code section below. - --> - -``` - -``` - -##### Netdata version - -<!-- -Provide output of `netdata -W buildinfo`. - -If your Netdata Agent is older, and doesn't support buildinfo, do the following: -Provide output of `netdata -V`. - -If Netdata is running, execute: $(ps aux | grep -E -o "[a-zA-Z/]+netdata ") -V - --> - -##### Installation method - -<!-- -Tell us which installation method you used (https://learn.netdata.cloud/docs/agent/packaging/installer#alternative-methods). - --> - -##### Component Name - -<!-- -Let us know which component is affected by the bug. Our code is structured according to its component, -so the component name is the same as the top level directory of the repository. -For example, a bug in the dashboard would be under the web component. ---> - -##### Steps To Reproduce - -<!-- -Describe how you found this bug and how we can reproduce it, preferably with a minimal test-case scenario. -If you'd like to attach larger files, use gist.github.com and paste in links. ---> - -1. ... -2. ... - -##### Expected behavior - -<!-- Provide a clear and concise description of what you expected to happen. --> |