Skip to content

Commit

Permalink
Upgrade issue templates (#320)
Browse files Browse the repository at this point in the history
* Encourage users to create a discussion rather than an issue for support

* Update and rename bug_report.md to bug_report.yml

* Update bug_report.yml

* Update and rename feature_request.md to feature_request.yml

* Update feature_request.yml

* Update feature_request.yml
  • Loading branch information
derekantrican authored Feb 28, 2023
1 parent e0924b9 commit 4f5d0bf
Show file tree
Hide file tree
Showing 5 changed files with 97 additions and 32 deletions.
18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: 🐛 Report a bug
description: Help improve GAS-ICS-Sync by reporting observed bugs. Got a question or need support? See "Have questions or need support?" instead!
body:
- type: markdown
attributes:
value: >
### ✋ **[READ FIRST] This is bug tracker, not a support forum**
If something isn't working right, you have questions or need help, [**create a discussion instead**](https://github.com/derekantrican/GAS-ICS-Sync/discussions).
Only proceed here if you are 100% sure the issue you are seeing is actually a bug. If in doubt, check
the discussions first, we can always file a bug from a support request later.
---
**Thank you for wanting to report a bug!**
- type: textarea
attributes:
label: The problem
description: >-
Describe the issue you are experiencing here. Tell us what you were trying to do
step by step, and what happened that you did not expect.
Provide a clear and concise description of what the problem is and include as many
details as possible.
placeholder: |
1. ...
2. ...
3. ...
validations:
required: true
- type: markdown
attributes:
value: |
## Environment
- type: input
attributes:
label: Version of GAS-ICS-Sync
description: Can be found near the bottom of the Helpers.gs file (look for `var thisVersion = 5.7;`)
validations:
required: true
- type: markdown
attributes:
value: |
## Other helpful information
- type: markdown
attributes:
value: >-
If you have any of the following, please include it:
* Screenshots
* An input ics string that can reproduce the problem (you can remove sensitive information with https://derekantrican.com/icssanitizer)
* Your settings (approx lines 34-50 of Code.gs. eg `var howFrequent = ....` and the following lines)
- type: textarea
attributes:
label: Additional information & file uploads
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: false
contact_links:
- name: 🤔 Have questions or need support?
url: https://github.com/derekantrican/GAS-ICS-Sync/discussions
about: Create a discussion
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: ✨ Request a feature
description: Request a new feature to implement in GAS-ICS-Sync
title: "[Request]"
body:
- type: markdown
attributes:
value: >
**Thank you for wanting to request a feature in GAS-ICS-Sync!**
Before you go ahead with your request, please note that any feature that is only
of interest to a small sub group will not be implemented. Only such features
that are of interest to a majority of users will be implemented as part of the script.
If you have a very specific request for your use case and would like help implementing
it, feel free to create a [discussion](https://github.com/derekantrican/GAS-ICS-Sync/discussions) instead and we can help you there.
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
description: Please describe the feature you would like to see (it would be helpful if you could add any necessary screenshots, [ics strings](https://github.com/derekantrican/GAS-ICS-Sync/wiki/Debugging-tips#using-an-explicit-ics-string-instead-of-an-url), etc)
- type: textarea
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen. Explain why it should be included in GAS-ICS-Sync.
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.

0 comments on commit 4f5d0bf

Please sign in to comment.