Add issue templates

This commit is contained in:
Angie 2024-07-19 15:56:40 -04:00
parent 1c22fdcc43
commit 4b20b6030d
4 changed files with 101 additions and 1 deletions

1
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1 @@
blank_issues_enabled: true

View File

@ -0,0 +1,45 @@
name: Feature suggestion
description: Suggest a new feature
title: "[Suggestion]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thank you for suggesting a new feature!
- type: textarea
id: the-feature
attributes:
label: Explain the feature
description: What does this new feature do? How it would be done?
placeholder: |
- Print capybara ascii art on each run
- Introduce achievements
- Play the Oof sound on errors
validations:
required: true
- type: textarea
id: advantage
attributes:
label: Advantage
description: What are the pros of this new feature?
placeholder: |
- XYZ is a common case.
- The produced assembly would be more correct because...
- Would fix Windows builds.
- type: textarea
id: disadvantage
attributes:
label: Disadvantage
description: What could be any drawback of the new feature?
placeholder: |
- Slower runtime.
- Harder to debug.
- Would fix Windows builds.
- type: textarea
id: example
attributes:
label: Example(s)
description: Include examples on how this feature would look like or related info.
validations:
required: true

54
.github/ISSUE_TEMPLATE/frug_report.yml vendored Normal file
View File

@ -0,0 +1,54 @@
name: Frug Report
description: File a frug report
title: "[Frug]: "
labels: ["frug"]
body:
- type: markdown
attributes:
value: |
Thank you for filing a frug report!
- type: textarea
id: what-happened
attributes:
label: Explain the problem.
description: What happened? What did you expect to happen?
placeholder: What went wrong?
validations:
required: true
- type: textarea
id: reproducer
attributes:
label: Reproducer
description: Please provide instructions to reproduce the problem.
placeholder: |
Use the following file (attach it please) and run IJK with parameters ABC.
Clone the repo on github.com/example/example and do XYZ
validations:
required: true
- type: input
id: rabbitizer-version
attributes:
label: rabbitizer version
description: What version of rabbitizer are you running? (`pip show rabbitizer` if installed via `pip` or check `include/common/RabbitizerVersion.h` if used as a C or C++ library)
validations:
required: true
- type: input
id: splat/spimdisasm-version
attributes:
label: "Optional: splat/spimdisasm version"
description: Were you running rabbitizer through splat or spimdisasm? What are their versions?
validations:
required: false
- type: textarea
id: other-version
attributes:
label: "Optional: Version of other stuff"
description: Here you can put the version of whatever other software you think may be relevant, like Python, rabbitizer, binutils, OS, etc.
placeholder: |
- Python: 4.18
- clang: 17
- binutils: 2.π
- Wine on WSL2 on Windows 11 on VirtualBox on OpenBSD on Minecraft command blocks.
- Etc
validations:
required: false

View File

@ -6,7 +6,7 @@ name = "rabbitizer"
# Version should be synced with include/common/RabbitizerVersion.h # Version should be synced with include/common/RabbitizerVersion.h
version = "1.11.3" version = "1.11.3"
description = "MIPS instruction decoder" description = "MIPS instruction decoder"
# license = "MIT" license = "MIT"
readme = "README.md" readme = "README.md"
requires-python = ">=3.7" requires-python = ">=3.7"
authors = [ authors = [