Skip to content

Commit

Permalink
Update issue, pr templates
Browse files Browse the repository at this point in the history
  • Loading branch information
raidensakura committed Mar 31, 2024
1 parent 103f2a0 commit e1f756d
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 52 deletions.
38 changes: 15 additions & 23 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
name: Bug Report
description: File a bug report
title: "[BUG]: your bug report title"
labels: "maybe: bug"
title: "[BUG]: "
labels: "bug"
body:
- type: input
id: bot-info-version
attributes:
label: Bot Version
description: Check it with `@modmail about`
placeholder: eg. v3.9.4
placeholder: eg. v4.2.0
validations:
required: true
- type: dropdown
Expand All @@ -17,39 +17,31 @@ body:
label: How are you hosting Modmail?
description: You can check it with `@modmail about` if you are unsure
options:
- Heroku
- Systemd
- PM2
- Patreon
- Local-hosting
- Docker
- Other
validations:
required: true
- type: input
id: logs
attributes:
label: Error Logs
placeholder: https://hastebin.cc/placeholder
label: Error Logs / Screenshot
placeholder: https://hastebin.cc/paste-id
description:
"If your Modmail bot is online, type `@modmail debug hastebin` and include the link here.
If your Modmail bot is not online or the previous command did not generate a link, do the following:
1. Select your *bot* application at https://dashboard.heroku.com
2. [Restart your bot](https://i.imgur.com/3FcrlKz.png)
3. Reproduce the error to populate the error logs
4. [Copy and paste the logs](https://i.imgur.com/TTrhitm.png)"
validations:
required: true
If your Modmail bot is not online or the previous command did not generate a link, restart your bot and verify the issue is reproducible.
After that, upload a screenshot of the **full** error into [postimages](https://postimages.org/) or any equivalent website, or
copy and paste **entire** error stack trace into the additional field below."
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: "[optional] You may add screenshots to further explain your problem."
label: Brief Description
description: "Provide a short description of the issue you're facing."
validations:
required: true
- type: textarea
id: additional-info
attributes:
label: Additional Information
description: "[optional] You may provide additional context for us to better understand how this issue occured."
description: "You may provide additional context or stack trace for us to better understand how this issue occured."
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Discord Server
url: https://discord.gg/etJNHCQ
url: https://dsc.gg/transience
about: Please ask hosting-related questions here before creating an issue.
37 changes: 9 additions & 28 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,46 +1,27 @@
name: Feature Request
description: Suggest an idea for this project
title: "your feature request title"
labels: "feature request"
title: "[FR]: "
labels: "enhancement"
body:
- type: textarea
id: problem-relation
attributes:
label: Is your feature request related to a problem? Please elaborate.
description: A clear and concise description of what the problem is.
placeholder: eg. I'm always frustrated when...
label: Feature Request.
description: A short, clear and concise description of what the suggestion is.
placeholder: eg. I would like Modmail to have...
validations:
required: true
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
label: Feature Description.
description: A detailed, clear and concise description of how the suggested feature would improve Modmail or solve problems the users are facing.
validations:
required: true
- type: checkboxes
id: complications
attributes:
label: Does your solution involve any of the following?
label: Which application is the feature intended for?
options:
- label: Modmail
- label: Logviewer
- label: New config option
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: true
- type: textarea
id: benefit
attributes:
label: Who will this benefit?
description: Does this feature apply to a great portion of users?
validations:
required: true
- type: textarea
id: additional-info
attributes:
label: Additional Information
description: "[optional] You may provide additional context or screenshots for us to better understand the need of the feature."

0 comments on commit e1f756d

Please sign in to comment.