Skip to content

Commit

Permalink
Create issue forms (#183)
Browse files Browse the repository at this point in the history
  • Loading branch information
hashalite authored Feb 28, 2024
2 parents f6811e6 + cad4ce6 commit f52d52b
Show file tree
Hide file tree
Showing 4 changed files with 182 additions and 0 deletions.
96 changes: 96 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
name: Bug report
description: Report something not working as expected
labels: ["bug", "unverified"]
body:
- type: markdown
attributes:
value: |
## Please check if an issue already exists
You can use the search box on our [issues page](https://github.com/MinecraftFreecam/Freecam/issues). Ensure you check both open issues as well as closed issues.
If you find the bug has already been reported, you can:
- **Subscribe** for updates on the issue
- **React** "👍" to show your interest
- Or **comment** if you have extra details to add
----
- type: textarea
id: description
attributes:
label: Description of the issue
placeholder: e.g. Nothing happens when I press the toggle key (`F4`)...
description: What happens?
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
placeholder: e.g. I expected Freecam to activate when pressing `F4`...
description: What did you expect to happen instead?
- type: textarea
id: reproduction
attributes:
label: Steps to reproduce
description: Steps to reproduce the issue
value: |
1. Open a singleplayer world
2. Enable Freecam by pressing `F4`
3. ...
- type: textarea
id: logs
attributes:
label: Log output
placeholder: Logs may help us to identify the issue
description: You can find logs in `.minecfaft/logs/latest.log`
render: shell
- type: textarea
id: crash-report
attributes:
label: Crash report
placeholder: If the game crashes, include your crash-report
description: You may find reports in `.minecfaft/crash-reports/crash-<date+time>-client.txt`
render: shell
- type: input
id: prevalence
attributes:
label: How prevalent is the issue?
description: How often do you or others encounter this issue?
placeholder: e.g. every time I press the key
- type: input
id: mod-version
attributes:
label: Freecam version
placeholder: 1.2.3
description: What version of Freecam are you usign?
validations:
required: true
- type: dropdown
id: modrinth
attributes:
label: Are you using "Modrinth Edition"?
description: Modrinth Edition has some additional restrictions, e.g. it will not allowing you to clip through blocks unless you are `op`, in creative, or in singleplayer.
options: [ "Yes", "No" ]
default: 1
validations:
required: true
- type: input
id: mc-version
attributes:
label: Minecraft version
placeholder: 1.20.4
description: What version of Minecraft are you using?
validations:
required: true
- type: checkboxes
id: mod-platform
attributes:
label: Modding platform
description: Select the platform(s) you've seen this issue on
options:
- label: Fabric
- label: Neoforge
- label: Forge
validations:
required: true
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Feature request
description: Suggest a new feature
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
## Please check if an issue already exists
You can use the search box on our [issues page](https://github.com/MinecraftFreecam/Freecam/issues). Ensure you check both open issues as well as closed issues.
If you find your idea has already been suggested, you can:
- **Subscribe** for updates on the issue
- **React** "👍" to show your interest
- Or **comment** if you have extra details to add
----
- type: textarea
id: description
attributes:
label: Description of the feature
description: |
What is your idea and how should it work?
The more detail you provide, the more likely we'll understand your idea and be able to implemnt it.
validations:
required: true
- type: textarea
id: why
attributes:
label: Why is this useful?
description: What problem does it solve? How would it help you?
- type: input
id: mod-version
attributes:
label: Freecam version
placeholder: 1.2.3
description: What version of Freecam are you currently using?
validations:
required: true

37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/3-language.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: New Language
description: Request we enable a new language in Crowdin
title: "[New Language]: "
labels: ["i18n"]
body:
- type: input
id: name
attributes:
label: Language name
placeholder: English (US)
validations:
required: true
- type: input
id: locale
attributes:
label: Locale code
placeholder: en_us
description: You can find a list of Minecraft locale codes [here](https://minecraft.wiki/w/Language#Languages).
validations:
required: true
- type: markdown
attributes:
value: |
Please don't request we enable a language if you don't intend to help translate it.
If you're unfamiliar with Crowdin, you can read their [getting started as a volunteer translator guide](https://support.crowdin.com/enterprise/getting-started-for-volunteers).
- type: checkboxes
id: already-enabled
attributes:
label: Please check if the language is already enabled
description: |
Before opening this request, please check that we don't already target your language on our [Crowdin project](https://crowdin.com/project/freecam).
If we do, you can use Crowdin to submit new translations or propose changes.
options:
- label: I have checked this language isn't enabled on Crowdin
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Translations
url: https://crowdin.com/project/freecam
about: You can help improve Freecam's translations using Crowdin.
- name: Questions and discussion
url: https://github.com/MinecraftFreecam/Freecam/discussions/new/choose
about: If the options above don't seem right, you may be better off starting a "discussion" instead.

0 comments on commit f52d52b

Please sign in to comment.