Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add github issue templates #358

Merged
merged 8 commits into from
Sep 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: 🐞 Bug report
description: Report a bug/issue
labels: [bug]
assignees: [wlorenzetti]
body:
- type: checkboxes
attributes:
label: Checklist
description: >
Please confirm the following:
options:
- label: I've searched through the existing [issues](https://github.com/g3w-suite/g3w-admin/issues) and this bug has never been reported before
required: false
- type: textarea
attributes:
label: Subject of the issue
description: Describe your issue here.
placeholder: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: textarea
attributes:
label: Environment
description: |
Please provide as much information as possible in order to resolve your issue. Need help? [Find out your version](https://github.com/g3w-suite/g3w-admin#version).
value: |
- g3w-admin: __version__
- g3-client: __version__
- browser: __name__
- operating system: __name and version (desktop or mobile)__
validations:
required: true
- type: input
attributes:
label: Link to your project
description: A public URL that can help others to check your issue
placeholder: eg. https://dev.g3wsuite.it/en/map/demo-34/
validations:
required: false
- type: textarea
attributes:
label: Additional info
description: |
Add any other useful information that could allow others to replicate your issue, for example:
- **installed plugins**
- **project structure**
- **configuration files**
- **self-explanatory pictures**
placeholder: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: ☝️ Feature request
description: Suggest an idea for this project
labels: 'feature'
assignees: [wlorenzetti]
body:
- type: checkboxes
attributes:
label: Checklist
description: >
Please confirm the following:
options:
- label: I've searched through the [current issues](https://github.com/g3w-suite/g3w-admin/issues) to make sure this feature hasn't been requested already.
required: false

- type: textarea
attributes:
label: Motivation
description: Is your feature request related to a problem? Provide a clear and concise description of what the problem is.
placeholder: e.g. "I'm always frustrated when [...]"
validations:
required: true

- type: textarea
attributes:
label: Suggested solution
description: Provide a clear and concise description of what you want to happen.
placeholder: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: true

- type: textarea
attributes:
label: Alternatives considered
description: Please describe any alternative solutions or features you've considered.
placeholder: Screenshots, video, links, etc.
validations:
required: false
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/improve_documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: 📄 Improve documentation
description: Suggest new additions or updates to existing documentation
labels: 'docs'
body:
- type: checkboxes
attributes:
label: Checklist
description: >
Please confirm the following:
options:
- label: I've searched through the [current issues](https://github.com/g3w-suite/g3w-admin/issues) to make sure this feature hasn't been requested already.
required: false

- type: input
attributes:
label: Which documents need updating?
description: >
For existing content, please provide one or more URLs of documents that need updating.
You may also provide [permalinks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-a-permanent-link-to-a-code-snippet) to the relevant source code.
placeholder: e.g. "https://g3w-suite.readthedocs.io/en/v.3.4.x/g3wsuite_administration.html"
validations:
required: false

- type: textarea
attributes:
label: Motivation
description: Why is this change needed? Provide a clear and concise description of what the problem is.
placeholder: >
e.g. "The documentation doesn't help me understand how to [...]"
validations:
required: true

- type: textarea
attributes:
label: Suggested changes
description: Provide a clear and concise description of the changes you want to see.
placeholder: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: true