Skip to content

Commit

Permalink
improve(tooling): add GitHub issue templates (#324)
Browse files Browse the repository at this point in the history
  • Loading branch information
Guts authored Jul 8, 2024
2 parents b0ab003 + f914304 commit 96f3211
Show file tree
Hide file tree
Showing 3 changed files with 216 additions and 0 deletions.
121 changes: 121 additions & 0 deletions .github/ISSUE_TEMPLATE/01-report-a-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
name: "🐛 Bug report"
description: "Report a bug or a strange behavior."
labels: ["triage"]
title: "[BUG]: "
assignees:
- Guts

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
id: cb_user_searched
attributes:
label: Is there an existing issue or a documentation page for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues and within documentation
required: true

- type: markdown
attributes:
value: |
----
## Environment
- type: input
id: in_qdt_version
attributes:
label: Which version of the app are you using?
validations:
required: true

- type: dropdown
id: dr_operating_system
attributes:
label: Operating System
description: |
On which operating systems did you met the bug?
Remember: those with a '*' are the officially supported.
If you pick `other`, please give more details in comment part at the end of form.
multiple: true
options:
- Linux Ubuntu*
- Windows 10+*
- MacOS 12
- Other
validations:
required: true

- type: dropdown
id: dr_packaging_mode
attributes:
label: Packaging mode
description: |
With which packaged mode did you encounter the bug.
multiple: true
options:
- CLI as stand-alone executable (.i.e DicoGIS-cli.exe or DicoGIS-cli.bin)
- GUI as stand-alone executable (.i.e DicoGIS-gui.exe or DicoGIS-gui.bin)
- Python package
- Source code
validations:
required: true

- type: textarea
id: tx_related_resources
attributes:
label: Related resources
description: |
Add details about your operating system, proxies, PostgreSQL version, upload datasets that you can share publicly here,
give URL to public resource with dataset directly...
Write everything you think it's necessary to describe your environment.
- type: markdown
attributes:
value: |
----
## Bug details
- type: textarea
id: tx_bug_description
attributes:
label: Description of the bug
description: Tell us what bug you encountered and what should have happened
validations:
required: true

- type: textarea
id: tx_reproduction_steps
attributes:
label: Steps to reproduce
description: Which steps do we need to take to reproduce this error?
placeholder: |
1. Open a terminal
1. Run DicoGIS in verbose mode (for example `DicoGIS-cli.exe --verbose`)
1. ...
- type: textarea
id: tx_logs
attributes:
label: Relevant log output
description: Run in verbose mode and provide log output. By default, logs files are stored in `~/.dicogis/logs` (~= `%USERHOME%\.dicogis\logs` in Windows)
render: Shell

- type: markdown
attributes:
value: |
----
## Miscellaneous
- type: textarea
id: tx_misc_comment
attributes:
label: Comment
description: Give details that you think they matter or just let a message to the team.
87 changes: 87 additions & 0 deletions .github/ISSUE_TEMPLATE/02-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
name: "➕ Feature request"
description: Want to submit an idea? Propose a change or feature request
labels:
- enhancement
- triage
title: "[Feature Request]: "
assignees:
- Guts

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request correctly.
- type: textarea
id: context
attributes:
label: Context
description: >-
This field is optional. You may provide additional context for the idea
you want to propose, helping us to understand what you are working on
and what you are trying to achieve. If the context is not relevant, you
can leave this field empty.
- type: textarea
id: description
attributes:
label: Description
description: >-
Please provide a detailed description of your idea in 2-3 sentences so
that we maintainers can fully understand what change, feature, or the
improvement you are proposing. Don't yet explain the benefits of your
idea, we'll come to that. Focus on functionality.
validations:
required: true

- type: textarea
id: related-links
attributes:
label: Related links
description: >-
Please list all links to open and closed [issues](https://github.com/Guts/DicoGIS/issues),
[discussions](https://github.com/Guts/DicoGIS/discussions),
or to [documentation sections](https://guts.github.io/DicoGIS/)
that are relevant to your idea.
If you discussed your idea with the community on our
[discussion board](https://github.com/Guts/DicoGIS/discussions)
prior to creating this change request, please link the discussion here as well.
validations:
required: true

- type: textarea
id: use-cases
attributes:
label: Use Cases
description: >-
Please explain how your idea will work from an QGIS admin's and user's
perspective. Elaborate on how the change would positively impact not only
you but the community and how it aligns with the goals and [philosophy](https://guts.github.io/DicoGIS/#what-is-it)
of the project.
validations:
required: true

- type: textarea
id: visuals
attributes:
label: Visuals
description: >-
This field is optional. You may provide sketches, screenshots, mockups,
or external assets to illustrate your idea.
placeholder: |-
Drag and drop images here or link external assets.
- type: checkboxes
id: checklist
attributes:
label: Before submitting
description:
Please ensure your idea fulfills all of the following requirements. If
you need clarification on a specific requirement, follow the link to
learn about it and understand why it is necessary before ticking the box.
This will save the maintainers and you valuable time.
options:
- label: >-
I have verified that my idea is a change request and not a bug report.
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Ask, answer, share
url: https://github.com/Guts/DicoGIS/discussions/
about: Have a question or need help? Have an answer or idea to share? Connect with the community on our discussion board
- name: Support DicoGIS development or want to use it in your organization?
url: https://guts.github.io/DicoGIS/misc/funding.html
about: Want to contract to use DicoGIS in your organization or to fund or sponsor a feature or a bug fix?

0 comments on commit 96f3211

Please sign in to comment.