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

Feature: GitHub Pull Request/Issues templates #840

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Bug Report
description: Something not behaving the way it should? Let us know!
title: "Bug: <Title>"
labels: ["bug"]
body:
- type: textarea
attributes:
label: Describe the bug
description: A clear description of what the bug is. Please consider adding pictures and/or videos, as they really help!
placeholder: |
When doing X, UndertaleModTool crashes.
validations:
required: true
- type: textarea
attributes:
label: Reproducing steps
description: Steps to reproduce the behavior.
placeholder: |
1. Open X ...
2. Do Y ...
3. See error
validations:
required: true
- type: textarea
attributes:
label: Setup Details
description: A clear and concise description of your tools and enviroment used.
placeholder: |
1. UndertaleModTool version: What UndertaleModTool version did you use? If compiled from source, please specify the commit number.
2. Operating system: Specify the OS and version e.g. Windows 10, Mac OS X Catalina, Ubuntu 20.04, etc.
3. GameMaker Game: What GameMaker game was used? Link to 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: false
contact_links:
- name: UnderMiners Discord
url: https://discord.gg/UMwccfs2Hb
about: For UndertaleModTool questions, discussion, analysis and feedback
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Suggest a Feature
description: Have an idea for something completely new that UndertaleModTool could benefit from having? Or for improving something that already exists? Let us know!
title: "Feature: <Title>"
labels: ["enhancement"]
body:
- type: dropdown
attributes:
label: Which component should be improved?
options: [UI/UX, Decompiler, Compiler, CLI, Lib, Other]
validations:
required: true
- type: textarea
attributes:
label: Describe your feature suggestion in more detail
description: A clear description of your feature suggestion. Feel free to add pictures or videos directly to this description!
placeholder: |
Give a clear explanation of what you want us to add.
Please don't give vague suggestions like "Make button look better" or "Add a new panel".
How exactly does it work? What are the inputs? What is the expected outcome?
validations:
required: true
8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## Description
<!-- A clear, in-depth description of what the changes are. Reference existing issues and add screenshots if necessary! -->

### Caveats
<!-- Any caveats, side effects or regressions of this PR -->

### Notes
<!-- Any notes or closing words -->