Skip to content

Commit

Permalink
Issue templates: use issue types
Browse files Browse the repository at this point in the history
  • Loading branch information
cbjeukendrup authored and Jojo-Schmitz committed Jan 18, 2025
1 parent 7efed82 commit 80f2c72
Show file tree
Hide file tree
Showing 5 changed files with 197 additions and 0 deletions.
107 changes: 107 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
name: Bug report
description: Report crashes or incorrect behaviour of existing functionality in MuseScore 3 Evolution.
type: Bug
body:
- type: dropdown
id: label
attributes:
label: Issue type
description: What kind of issue are you experiencing?
options:
- Choose option...
- Crash or freeze
- Engraving bug (incorrect score rendering)
- UX/Interaction bug (incorrect behaviour)
- UI bug (incorrect info or interface appearance)
- Accessibility issue (e.g. for keyboard-only or screen reader users)
- General playback bug
- Cloud issue (opening, saving, logging in/out)
- Opening/saving issue
- Import/export issue
- File corruption
- Other type of issue
validations:
required: true
- type: textarea
id: steps
attributes:
label: Description with steps to reproduce
description: Please also describe the actual (current) and expected behaviour
placeholder: |
1. go to ...
2. then click on ...
3. then ...
Actual behaviour:
Expected behaviour:
validations:
required: true
- type: textarea
id: evidence
attributes:
label: Supporting files, videos and screenshots
description: |
* For crashes: a short screen recording (ideally 20sec or less)
* For engraving issues: one or more screenshots (or a short screen recording, 20sec or less) showing the problem and, where possible, the expected outcome
* For playback issues:
* A short screen recording with audio of a minimal reproducible example
* A score containing the problem (please upload as a .zip file)
* Examples comparing both MS Basic and Muse Sounds (where applicable)
* For UI/interaction and all other issues: a short screen recording (ideally 20sec or less) and files (where applicable; please upload as a .zip file).
placeholder: |
Click into this text box and paste your files, videos and screenshots here.
validations:
required: true
- type: input
id: version
attributes:
label: What is the latest version of MuseScore 3 Evolution where this issue is present?
description: |
You can copy the info from the Help > About dialog in MuseScore 3 Evolution.
If you can, please also check whether this issue is still present in the _latest_ [nightly build](https://github.com/Jojo-Schmitz/MuseScore/actions)
validations:
required: true
- type: dropdown
id: regression
attributes:
label: Regression
description: Did this work before? Older versions of MuseScore 3 Evolution can be found [here](https://github.com/Jojo-Schmitz/MuseScore/actions).
options:
- Choose option...
- No.
- Yes, this used to work in MuseScore 3.x and now is broken
- Yes, this works in MuseScore 4.x
- Yes, this works in a previosus version and is broken in the nightly builds
- I was unable to check
validations:
required: true
- type: input
id: os
attributes:
label: Operating system
description: What OS does this bug occur on?
placeholder: Windows 11, macOS 13, Ubuntu 22.04, etc.
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional context
description: Further information which may be relevant to this bug

- type: checkboxes
id: checklist
attributes:
label: Checklist
description: "Before submitting your bug report, please make sure the following requirements are met:"
options:
- label: "This report follows the [guidelines](https://github.com/musescore/MuseScore/wiki/Reporting-bugs-and-issues) for reporting bugs and issues"
required: true
- label: "I have verified that this issue has not been logged before, by searching the [issue tracker](https://github.com/Jojo-Schmitz/MuseScore/issues) for similar issues"
required: true
- label: "I have attached all requested files and information to this report"
required: true
- label: "I have attempted to identify the root problem as concisely as possible, and have used minimal reproducible examples where possible"
required: true
- type: markdown
attributes:
value: If an issue does not meet these requirements, it may be closed without investigation.
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
contact_links:
- name: Support forum
url: https://musescore.org/en/forum/6
about: Get help solving a problem or checking if something is a bug in MuseScore Studio.
- name: Discord server
url: https://discord.gg/HwHhXEbJ4r
about: >-
Ask development questions (programming, translating, etc.) and chat with
the MuseScore Studio development team, other contributors, and users.
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Feature request
description: Request new functionality or enhancements to existing features in MuseScore 3 Evolution.
type: Feature
body:
- type: textarea
id: idea
attributes:
label: Your idea
description: Describe your idea in a few sentences.
validations:
required: true
- type: textarea
id: whatfor
attributes:
label: Problem to be solved
description: What problem would your idea solve?
validations:
required: true
- type: textarea
id: other
attributes:
label: Prior art
description: Have you run into this problem with other apps? How did they solve it? You can paste screenshots.
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional context
description: Anything else of note
validations:
required: false

- type: checkboxes
id: checklist
attributes:
label: Checklist
description: "Before submitting your bug report, please make sure the following requirements are met:"
options:
- label: "This request follows the [guidelines](https://github.com/musescore/MuseScore/wiki/Reporting-bugs-and-issues) for reporting issues"
required: true
- label: "I have verified that this feature request has not been logged before, by searching the [issue tracker](https://github.com/Jojo-Schmitz/MuseScore/issues) for similar requests"
required: true
- type: markdown
attributes:
value: If a feature request does not meet these requirements, it may be closed without investigation.
25 changes: 25 additions & 0 deletions .github/issue_add_label_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
crash:
- "Crash or freeze"
engraving:
- "Engraving bug \\(incorrect score rendering\\)"
"UX/interaction":
- "UX/Interaction bug \\(incorrect behaviour\\)"
UI:
- "UI bug \\(incorrect info or interface appearance\\)"
accessibility:
- "Accessibility issue \\(e\\.g\\. for keyboard-only or screen reader users\\)"
playback:
- "General playback bug"
cloud:
- "Cloud issue \\(opening, saving, logging in/out\\)"
corruption:
- "File corruption"
"needs review":
- "Other type of issue"

"regression MS3":
- "Yes, this used to work in MuseScore 3.x and now is broken"
"regression MS4":
- "Yes, this works in MuseScore 4.x"
"regression nightly":
- "Yes, this works in a previous version and is broken in the nightly builds"
10 changes: 10 additions & 0 deletions .github/issue_assign_by_label_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
crash:
- Jojo-Schmitz
- Jojo-Schmitz
- Jojo-Schmitz
engraving:
- Jojo-Schmitz
playback:
- Jojo-Schmitz
cloud:
- Jojo-Schmitz

0 comments on commit 80f2c72

Please sign in to comment.