From 82126920350ddb3bdc48ad795c43450b9d0d7bd0 Mon Sep 17 00:00:00 2001 From: "s.samko" Date: Tue, 27 Feb 2024 10:39:14 +0000 Subject: [PATCH] Feature #10426 - new issue menu templates --- .github/ISSUE_TEMPLATE/01_issueTemplate.yaml | 113 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 12 ++ .github/SECURITY.md | 1 + .github/workflows/add-comment.yml | 25 ++++ 4 files changed, 151 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/01_issueTemplate.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/workflows/add-comment.yml diff --git a/.github/ISSUE_TEMPLATE/01_issueTemplate.yaml b/.github/ISSUE_TEMPLATE/01_issueTemplate.yaml new file mode 100644 index 00000000000..3fd468de832 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_issueTemplate.yaml @@ -0,0 +1,113 @@ +name: Report a Bug +description: Provide a general summary of the issue found in the Title field below and then complete the remainder of the form. +labels: ["Type: Bug"] +body: + - type: markdown + attributes: + value: | + Before you open an issue: + - check if a similar issue already exists or has been closed previously. + - if you have discovered a security risk, a security risk, please refer to our [Security Policy](https://docs.suitecrm.com/community/security-policy) + + Please note, only issues found which are valid in supported versions of SuiteCRM 7, will be investigated. + Issues found in SuiteCRM 8 and above should be raised [here](https://github.com/salesagility/SuiteCRM-Core/issues/new/choose) + + - type: textarea + id: issue + attributes: + label: Issue + description: Provide a detailed description for the issue, why you consider it to be a bug and what you expect should happen + placeholder: Ensure that all code ``` is surrounded ``` by triple back quotes. This can also be done over multiple lines. + validations: + required: true + - type: textarea + id: possible-fix + attributes: + label: Possible Fix + description: Not obligatory, but suggest a fix or reason for the bug + validations: + required: false + - type: textarea + id: steps + attributes: + label: Steps to Reproduce the Issue + description: Provide a link to a live example or the steps taken to produce this bug including code to reproduce, if relevant + value: | + 1. + 2. + 3. + ... + render: bash + validations: + required: true + - type: textarea + id: context + attributes: + label: Context + description: We appreciate it if you could give us more context - how has this bug affected you? What were you trying to accomplish? + validations: + required: false + - type: markdown + attributes: + value: + "## " + - type: markdown + attributes: + value: + "## Your Environment:" + - type: input + id: version + attributes: + label: Version + description: What version of SuiteCRM are you running? + placeholder: ex. 7.14.3 + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: What browser are you currently using? + options: + - Chrome + - Firefox + - Safari + - Microsoft Edge + - Other + default: 0 + validations: + required: true + - type: input + id: browser-version + attributes: + label: Browser Version + description: We would like you to be a little bit more specific. + placeholder: ex. Chrome Version 122.0.6261.57/58 (64-bit) + validations: + required: false + - type: input + id: environment + attributes: + label: Environment Information + placeholder: ex. MySQL, PHP 8.2 + validations: + required: true + - type: input + id: os + attributes: + label: Operating System and Version + placeholder: ex. Ubuntu 23.10 + validations: + required: true + - type: markdown + attributes: + value: | + > **Remember to support your issue by voting!** + Get more information [here](https://docs.suitecrm.com/community/raising-issues/issues-voting/) + - type: markdown + attributes: + value: + "## " + - type: markdown + attributes: + value: + "## Thank you for bringing this issue to our attention!" diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..1f538eb7c5b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,12 @@ +blank_issues_enabled: false +contact_links: + - name: Request a Feature/Suggestion/Enhancement + url: https://community.suitecrm.com/c/suggestion-box/13 + about: If you would like to request an enhancement/feature, please do so via the forum, as this allows community members to vote for the suggestions more easily + - name: Raise a Documentation Issue + url: https://github.com/salesagility/SuiteDocs/issues/new + about: Please use this item if you would like to report a documentation issue + button-text: Start + - name: Raise a SuiteCRM 8 Bug + url: https://github.com/salesagility/SuiteCRM-Core/issues/new/choose + about: Use this item if your issue is specific to SuiteCRM 8 and above diff --git a/.github/SECURITY.md b/.github/SECURITY.md index eabe471e4cb..bea108ddf60 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -5,5 +5,6 @@ For a list of supported versions, please see the documentation [Supported Versions](https://docs.suitecrm.com/community/supported-versions/) page. ## Reporting a Vulnerability +To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/salesagility/SuiteCRM/security/advisories/new) tab. For details on how to report a vulnerability please check our [Security Policy](https://docs.suitecrm.com/community/security-policy/) page. diff --git a/.github/workflows/add-comment.yml b/.github/workflows/add-comment.yml new file mode 100644 index 00000000000..d6c58b5b5a5 --- /dev/null +++ b/.github/workflows/add-comment.yml @@ -0,0 +1,25 @@ +name: Add comment +on: + issues: + types: + - labeled +jobs: + add-comment: + if: contains(github.event.label.name, 'Bug') + runs-on: ubuntu-latest + permissions: + issues: write + steps: + - name: Add comment + run: gh issue comment "$NUMBER" --body "$BODY" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_REPO: ${{ github.repository }} + NUMBER: ${{ github.event.issue.number }} + BODY: | + Hey @${{ github.actor }}! + Thanks for contributing to the SuiteCRM project :sparkles: + + > **Remember to support your issue by voting!** + Get more information [here](https://docs.suitecrm.com/community/raising-issues/issues-voting/) + reactions: '+1'