Skip to content

Commit

Permalink
add issue templates (#250)
Browse files Browse the repository at this point in the history
* add issue templates

* make these templates actually work

* config.yaml -> config.yml

* issue template files are now `.yml` instead of `.yaml` for consistency's sake

* add blurb about making sure to use the latest browser version

* Apply suggestions from code review

Co-authored-by: Southpaw <[email protected]>

* "Feature Request" -> "Enhancement"

* improve bug_report.yml

* "Feature Request" -> "Enhancement" again...

* fix field ids

* screw it, lets update the editorconfig too

* add template for reporting content issues

* Apply suggestions from code review

Co-authored-by: Southpaw <[email protected]>

* rename feature_request.yml to enhancement.yml

* remove OS info field

* remove discord links

* remove browser input field

* Apply suggestions from code review

Co-authored-by: Southpaw <[email protected]>

* Update .github/ISSUE_TEMPLATE/enhancement.yml

Co-authored-by: Southpaw <[email protected]>

[skip ci]

---------

Co-authored-by: Southpaw <[email protected]>
  • Loading branch information
woodiertexas and Southpaw1496 authored Sep 4, 2024
1 parent 7b180e9 commit 15d1936
Show file tree
Hide file tree
Showing 5 changed files with 88 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ end_of_line=lf
insert_final_newline=true
trim_trailing_whitespace=true

[*.yml]
[*.{yml,yaml}]
indent_style = space
indent_size = 2
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Bug Report
description: Report a bug or unexpected behaviour with the website.
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report this bug!
- type: textarea
id: how-to-reproduce
attributes:
label: Reproduction steps
description: "Please describe how to reproduce the bug."
validations:
required: true

- type: textarea
id: expected-results
attributes:
label: Expected results
description: "What should happen when you follow the reproduction steps?"
validations:
required: true

- type: textarea
id: actual-results
attributes:
label: Actual results
description: "What actually happened?"
validations:
required: true

- type: input
id: device-and-os
attributes:
label: Device and OS
description: The type of device and operating system you were using when the error occurred.
validations:
required: true

- type: input
id: browser
attributes:
label: Browser information.
description: "The browser you were using and its version, if you know it."
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Join the Discord for support.
url: https://discord.quiltmc.org
about: Discuss the Quilt website on our Discord server.
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/content_issue_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Content Issue Report
description: Report a content issue on the website.
labels: [content issue]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report this content issue!
- type: textarea
id: description
attributes:
label: Describe the issue
description: "Please describe the content issue you found."
validations:
required: true
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Enhancement
description: Suggest a new feature or improvement for the website.
labels: [enhancement]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest this enhancement!
- type: textarea
id: description
attributes:
label: Describe what feature(s) you want.
description: "Describe the enhancement in as much detail as possible. What does it do? What problem does it solve? How might it work?"
validations:
required: true

0 comments on commit 15d1936

Please sign in to comment.