Skip to content

Commit

Permalink
improving issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
edulix committed Oct 10, 2023
1 parent 8ae3e18 commit 667cc43
Show file tree
Hide file tree
Showing 3 changed files with 81 additions and 29 deletions.
53 changes: 24 additions & 29 deletions .github/ISSUE_TEMPLATE/01-bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: `<insert election-config.json here>`.
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: `<insert-screenshot-here>`.
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
Expand All @@ -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
```
Expand All @@ -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
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/03-security-updates.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# SPDX-FileCopyrightText: 2023 Sequent Tech Inc <legal@sequentech.io>
#
# 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
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/04-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# SPDX-FileCopyrightText: 2023 Sequent Tech Inc <legal@sequentech.io>
#
# SPDX-License-Identifier: AGPL-3.0-only

name: Release
description: Generate a new release of the platform.
title: "Release <version>"
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 <major>xx deployment
- [ ] Deploy release in demo
- [ ] Deploy release in web-demo
```
validations:
required: false

0 comments on commit 667cc43

Please sign in to comment.