From 667cc4325d9ddee78d2de94b67006a7fc6168707 Mon Sep 17 00:00:00 2001 From: Eduardo Robles Elvira Date: Tue, 10 Oct 2023 09:28:25 +0200 Subject: [PATCH] improving issue templates --- .github/ISSUE_TEMPLATE/01-bug.yml | 53 +++++++++---------- .../ISSUE_TEMPLATE/03-security-updates.yml | 31 +++++++++++ .github/ISSUE_TEMPLATE/04-release.yml | 26 +++++++++ 3 files changed, 81 insertions(+), 29 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/03-security-updates.yml create mode 100644 .github/ISSUE_TEMPLATE/04-release.yml diff --git a/.github/ISSUE_TEMPLATE/01-bug.yml b/.github/ISSUE_TEMPLATE/01-bug.yml index 1fae245..e548e80 100644 --- a/.github/ISSUE_TEMPLATE/01-bug.yml +++ b/.github/ISSUE_TEMPLATE/01-bug.yml @@ -15,42 +15,44 @@ body: options: - label: "I could not find a solution in the existing issues, docs, nor discussions." required: true + - label: "I have attached screenshots and/or the specific steps to reproduce this issue." + required: true + - label: "I have attached a minimal `election.json` configuration to reproduce this issue (provide one for each different use-case)." + required: true - type: textarea attributes: label: Current Behavior - description: A concise description of what you're experiencing. + description: A concise description of what you're experiencing, including screenshots if possible. validations: required: true - type: textarea attributes: label: Expected Behavior - description: A concise description of what you expected to happen. + description: A concise description of what you expected to happen instead. validations: required: true - type: textarea attributes: label: Steps To Reproduce - description: Steps to reproduce the behavior. - placeholder: | - 1. In this environment... - 2. With this config... - 3. Run '...' - 4. See error... + description: | + Steps to reproduce the behavior, including `election.json` if possible. + Tip: You can attach images or config files files by clicking this area to highlight it and then dragging files in. + value: | + 1. In the Admin Portal, click in `New Election` in the sidebar, then click in `Create Election`. + 2. Click in `Actions` button and then click in `Edit JSON` in the popup moenu and paste the following election configuration json into the modal dialog and accept: ``. + 3. Then click in `Actions` button and then click in `Live preview` to open the voting booth. + 4. In the start screen, the error appears as highlighted in red in the screenshot below: ``. validations: - required: false + required: true - type: textarea attributes: label: Environment - description: | - examples: - - **OS**: Ubuntu 20.04 - - **Web browser**: Google Chrome 112.0.5615.137 (Official Build) (arm64) value: | - - OS: - - Web browser: - render: markdown + - **OS**: Mac OS X Ventura + - **Web browser**: Google Chrome 112.0.5615.137 (Official Build) (arm64) + - **Sequent Platform Version**: 10.0.0 validations: - required: false + required: true - type: textarea attributes: label: Tasks @@ -59,11 +61,13 @@ body: value: | ```[tasklist] # Tasks - - [ ] Task 1 + - [ ] Issue has been triaged + - [ ] Successful replication of the defect + - [ ] Successful defect resolution merged ``` ```[tasklist] - # Master PRs + # Main PRs - [ ] PR 1 ``` @@ -72,13 +76,4 @@ body: - [ ] PR 1 ``` validations: - required: false - - type: textarea - attributes: - label: Additional context - description: | - Links? References? Screenshots? Possible Solution? Anything that will give us more context about the issue you are encountering! - - Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. - validations: - required: false + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/03-security-updates.yml b/.github/ISSUE_TEMPLATE/03-security-updates.yml new file mode 100644 index 0000000..e44060c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-security-updates.yml @@ -0,0 +1,31 @@ +# SPDX-FileCopyrightText: 2023 Sequent Tech Inc +# +# SPDX-License-Identifier: AGPL-3.0-only + +name: Security updates +description: Perform security updates before creating a release. +title: "Security updates" +labels: [security] +body: + - type: textarea + attributes: + label: Tasks + description: | + Tasks lists to close this issue + value: | + ```[tasklist] + # Tasks + - [ ] Perform the security updates + ``` + + ```[tasklist] + # Master PRs + - [ ] PR 1 + ``` + + ```[tasklist] + # Stable PRs + - [ ] PR 1 + ``` + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/04-release.yml b/.github/ISSUE_TEMPLATE/04-release.yml new file mode 100644 index 0000000..79306c8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-release.yml @@ -0,0 +1,26 @@ +# SPDX-FileCopyrightText: 2023 Sequent Tech Inc +# +# SPDX-License-Identifier: AGPL-3.0-only + +name: Release +description: Generate a new release of the platform. +title: "Release " +labels: [release] +body: + - type: textarea + attributes: + label: Tasks + description: | + Tasks lists to close this issue + value: | + ```[tasklist] + # Tasks + - [ ] Tag the release + - [ ] Create releases with automatic release notes in github + - [ ] Test the release + - [ ] Deploy release in stable xx deployment + - [ ] Deploy release in demo + - [ ] Deploy release in web-demo + ``` + validations: + required: false