From 658491e0201e465943b9a72e900114448f967afe Mon Sep 17 00:00:00 2001 From: aneeshchakko Date: Wed, 24 Jul 2024 16:06:32 -0400 Subject: [PATCH] adding the github templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 123 ++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 23 ++++ .github/ISSUE_TEMPLATE/documentation_issue.md | 14 ++ .github/ISSUE_TEMPLATE/feature_request.md | 21 +++ 4 files changed, 181 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation_issue.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..32d3b3f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,123 @@ +name: Bug Report +description: Open a bug report +title: "[Bug] " +labels: ["Potential Bug", "To Triage"] +body: + - type: markdown + attributes: + value: | + Please contact the Matomo community forum for questions: https://forum.matomo.org/ + If this bug is regarding a premium plugin you purchased on plugins.matomo.org, please email shop@matomo.org instead of creating a bug report here. + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Please tell us what happens instead of the expected behavior. + placeholder: Tell us what you see, e.g. "An error messaged shows when I visit Overview under Visitors" + validations: + required: true + - type: textarea + id: what-should-actually-happen + attributes: + label: What should happen? + description: Please tell us what should happen. How has this issue affected you? What are you trying to accomplish? + placeholder: Tell us what you expect to see, e.g. "I should see Visits Over Time and Visits Overview" + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: How can this be reproduced? + description: For UI bugs, please try to reproduce that on our Demo (https://demo.matomo.cloud). If possible, please include the URLs and steps how to reproduce it there. For other bugs or UI bugs that can't be reproduced on Demo, please include any relevant URLs or commands you are using that may help us to reproduce the bug. + placeholder: Steps to reproduce, e.g. "Go to [Matomo-URL] > Click on Visitors > Click Overview" + validations: + required: true + - type: input + id: customer-website-name + attributes: + label: Website Name + description: Website Name + validations: + required: false + - type: dropdown + id: installation + attributes: + label: On Premise or Cloud + multiple: false + options: + - On Premise + - Cloud + validations: + required: true + - type: dropdown + id: priority + attributes: + label: Priority + multiple: false + options: + - 1 - Critical + - 2 - High + - 3 - Medium + - 4 - Low + validations: + required: false + - type: input + id: version + attributes: + label: Matomo version + description: What version of Matomo are you running? + validations: + required: true + - type: input + id: php-version + attributes: + label: PHP version + description: What version of PHP are you running? + validations: + required: false + - type: input + id: server-os + attributes: + label: Server operating system + description: What server operating system are you using? + validations: + required: false + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - Other + - Not applicable (e.g. an API call etc.) + - type: input + id: machine-os + attributes: + label: Computer operating system + description: What operating system are you using on your computer? + validations: + required: false + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: checkboxes + id: code + attributes: + label: Validations + description: "Before submitting the issue, please make sure you do the following:" + options: + - label: Read our [Contributing Guidelines](https://github.com/matomo-org/matomo/blob/5.x-dev/CONTRIBUTING.md). + required: true + - label: Follow our [Security Policy](https://github.com/matomo-org/matomo/blob/5.x-dev/SECURITY.md). + required: true + - label: Check that there isn't already an issue that reports the same bug to avoid creating duplicates. + required: true + - label: The provided steps to reproduce is a [minimal reproducible](https://stackoverflow.com/help/minimal-reproducible-example) of the Bug. + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..9a3b69e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,23 @@ +blank_issues_enabled: true +contact_links: + - name: Tag Manager Issue + url: https://github.com/matomo-org/tag-manager/issues/new + about: Create a Tag Manager related report + - name: Log Analytics Issue + url: https://github.com/matomo-org/matomo-log-analytics/issues/new + about: Create a Log Analytics related report + - name: Developer Documentation Issue + url: https://github.com/matomo-org/developer-documentation/issues/new + about: Create an issue that is related to our developer documentation + - name: Premium Plugin Issue + url: https://matomo.org/support/ + about: Report issues that are related to premium plugins + - name: Support/Usage Question + url: https://forum.matomo.org/ + about: Feel free to ask anything + - name: Developer Documentation + url: https://developer.matomo.org/ + about: Official documentation + - name: Translation feedback + url: https://matomo.org/translations/ + about: Share feedback / help on translations diff --git a/.github/ISSUE_TEMPLATE/documentation_issue.md b/.github/ISSUE_TEMPLATE/documentation_issue.md new file mode 100644 index 00000000..51094f7e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_issue.md @@ -0,0 +1,14 @@ +--- +name: "Documentation issue" +about: Some information within the documentation is wrong or missing +labels: ["documentation", "To Triage"] + +--- + + + + + + + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..9c2e72d4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,21 @@ +--- +name: "Feature request" +about: You think Matomo lacks some feature it should have? +labels: ["Enhancement", "To Triage"] + +--- + + + + + +## Summary + + +## Your Environment + + +* Matomo Version: +* PHP Version: +* Server Operating System: +* Additionally installed plugins: