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 issue templates #250

Merged
merged 21 commits into from
Sep 4, 2024
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
e65570b
add issue templates
woodiertexas Sep 4, 2024
6751e03
make these templates actually work
woodiertexas Sep 4, 2024
31e0f9c
config.yaml -> config.yml
woodiertexas Sep 4, 2024
c125d6d
issue template files are now `.yml` instead of `.yaml` for consistenc…
woodiertexas Sep 4, 2024
8bd9874
add blurb about making sure to use the latest browser version
woodiertexas Sep 4, 2024
96fee4c
Apply suggestions from code review
woodiertexas Sep 4, 2024
4cde3eb
"Feature Request" -> "Enhancement"
woodiertexas Sep 4, 2024
9ec63e1
improve bug_report.yml
woodiertexas Sep 4, 2024
a638fba
Merge remote-tracking branch 'origin/add-issue-templates' into add-is…
woodiertexas Sep 4, 2024
e6bff30
"Feature Request" -> "Enhancement" again...
woodiertexas Sep 4, 2024
2a7759a
fix field ids
woodiertexas Sep 4, 2024
084a2a8
screw it, lets update the editorconfig too
woodiertexas Sep 4, 2024
9fb9608
add template for reporting content issues
woodiertexas Sep 4, 2024
112963c
Apply suggestions from code review
woodiertexas Sep 4, 2024
560cf17
rename feature_request.yml to enhancement.yml
woodiertexas Sep 4, 2024
c338a09
Merge remote-tracking branch 'origin/add-issue-templates' into add-is…
woodiertexas Sep 4, 2024
b6d5db3
remove OS info field
woodiertexas Sep 4, 2024
550f4d3
remove discord links
woodiertexas Sep 4, 2024
ee29934
remove browser input field
woodiertexas Sep 4, 2024
48f0b53
Apply suggestions from code review
woodiertexas Sep 4, 2024
ce04142
Update .github/ISSUE_TEMPLATE/enhancement.yml
woodiertexas Sep 4, 2024
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
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
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Bug Report
description: Report a bug or unexpected behaviour with the website.
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thanks for taking your time to report this bug! If you need real-time help, join us on [Discord](https://discord.quiltmc.org).
woodiertexas marked this conversation as resolved.
Show resolved Hide resolved

- type: textarea
woodiertexas marked this conversation as resolved.
Show resolved Hide resolved
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: "Please describe what you expected to happen."
woodiertexas marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true

- type: textarea
id: actual-results
attributes:
label: Actual results
description: "Please describe what actually happened."
woodiertexas marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true

- type: textarea
woodiertexas marked this conversation as resolved.
Show resolved Hide resolved
id: device-and-os
attributes:
label: What device are you using and what OS is it running?
woodiertexas marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true

- type: textarea
woodiertexas marked this conversation as resolved.
Show resolved Hide resolved
id: browser
attributes:
label: Which browser are you using? If you know your browser version, please specify it.
description: "Please be sure you're on the latest version of the browser you are currently using."
woodiertexas marked this conversation as resolved.
Show resolved Hide resolved
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.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/content_issue_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Content Issue Report
description: Report a content issue on the website.
labels: [bug]
woodiertexas marked this conversation as resolved.
Show resolved Hide resolved
body:
- type: markdown
attributes:
value: |
Thanks for taking your time to report this content issue! If you need real-time help, join us on [Discord](https://discord.quiltmc.org).

- type: textarea
id: description
attributes:
label: Describe the issue
description: "Please describe what went wrong with the website content."
woodiertexas marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true

- type: textarea
woodiertexas marked this conversation as resolved.
Show resolved Hide resolved
id: device-and-os
attributes:
label: What device are you using and what OS is it running?
validations:
required: true

- type: textarea
woodiertexas marked this conversation as resolved.
Show resolved Hide resolved
id: browser
attributes:
label: Which browser are you using? If you know your browser version, please specify it.
description: "Please be sure you're on the latest version of the browser you are currently using."
validations:
required: true
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
woodiertexas marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Enhancement
description: Suggest a new feature or improvement for the website.
labels: [enhancement]
body:
- type: markdown
attributes:
value: |
Thanks for taking your time to create your feature request! If you want to discuss your request, join us on [Discord](https://discord.quiltmc.org).

- 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

- type: textarea
Copy link
Contributor

@Southpaw1496 Southpaw1496 Sep 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think the Additional Information field is necessary since the one above it is free text.

id: additional-info
attributes:
label: Additional Information
description: "Add any other information about your feature request here."