Skip to content

Commit d9055dd

Browse files
ethancrawfordethancrawford
committed
GitHub - add issue and pull request templates
This change add a pull request template, as well as issue template forms for Sonic Pi startup issues, runtime issues, compiling issues and feature requests.
1 parent e6eae2e commit d9055dd

File tree

5 files changed

+361
-0
lines changed

5 files changed

+361
-0
lines changed

Diff for: ‎.github/ISSUE_TEMPLATE/COMPILING-ISSUE-FORM.yml

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: A problem with compiling Sonic Pi
2+
description: I had a problem when compiling my own build of Sonic Pi from the source code.
3+
labels: ["triage","developer experience"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Hello! Thank you for wanting to raise an issue for us, so that we know what's not working for you.
9+
10+
Sorry you're having issues compiling Sonic Pi! We're always working to improve the build experience.
11+
12+
The core Sonic Pi development team is fairly small and made up of volunteers (with the exception of Sam Aaron, who relies much on crowd-funding) so the more help we can receive to manage, troubleshoot and hopefully fix your issues for you the better - help us to help you! Please follow the checklist below - that way you might not even need to raise an issue after all :smile:
13+
- type: checkboxes
14+
id: read-troubleshooting-guide
15+
attributes:
16+
label: Prerequisites
17+
options:
18+
- label: I've read the [Sonic Pi troubleshooting guide](https://github.com/sonic-pi-net/sonic-pi/wiki/Troubleshooting-Issues) and followed its suggestions where relevant
19+
required: true
20+
- type: input
21+
id: dev-commit
22+
attributes:
23+
label: Git commit id
24+
description: "What was the Git commit id of the code you were trying to compile from?"
25+
placeholder: "Example: 00f737e"
26+
validations:
27+
required: true
28+
- type: input
29+
id: os-version
30+
attributes:
31+
label: Operating System
32+
description: "What Operating System (and which version) were you using?"
33+
placeholder: "Example: Windows 10"
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: build-steps
38+
attributes:
39+
label: What steps did you take to set up and to try to compile Sonic Pi?
40+
description: |
41+
You can drag related images into the description if you like.
42+
When attempting to compile Sonic Pi, what steps did you take?
43+
Provide as much detail as possible - such as:
44+
- Software dependencies you set up for the build - versions, places they were downloaded from, etc
45+
- Any build steps you took that were different to those described in the build guides ([BUILD-LINUX.md](https://github.com/sonic-pi-net/sonic-pi/blob/dev/BUILD-LINUX.md), [BUILD-MAC.md](https://github.com/sonic-pi-net/sonic-pi/blob/dev/BUILD-MAC.md), [BUILD-RASPBERRY-PI.md](https://github.com/sonic-pi-net/sonic-pi/blob/dev/BUILD-RASPBERRY-PI.md) or [BUILD-WINDOWS.md](https://github.com/sonic-pi-net/sonic-pi/blob/dev/BUILD-WINDOWS.md)) - including the order you performed them
46+
For any steps you ran in the command line terminal, write or copy them here. Please use code formatting when you do so - if you're not sure how, please see the 'Code' examples at GitHub's [Mastering Markdown examples](https://guides.github.com/features/mastering-markdown/#examples).
47+
placeholder: "Example: I followed BUILD-LINUX.md, installing Qt 6.2.3 from https://www.qt.io/download-thank-you?os=linux&hsLang=en ..."
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: what-happened
52+
attributes:
53+
label: What happened?
54+
description: |
55+
You can drag related images into the description if you like.
56+
Copy the results of the build process here, including errors. If there is an error message that you feel has a clear cause or explanation, you can paste just the error plus a small amount of the messages around it for context. If in doubt however, the more information you can give us the better - such as the entire build process output, in case more detailed investigation is necessary.
57+
placeholder: |
58+
Example: When I run `cmake --build . --config Release` I get the following result:
59+
```
60+
c++: fatal error: Killed signal terminated program cc1plus
61+
compilation terminated.
62+
make[2]: *** [gui/qt/CMakeFiles/sonic-pi.dir/build.make:3658: gui/qt/CMakeFiles/sonic-pi.dir/sonic-pi_autogen/EWIEGA46WW/qrc_SonicPi.cpp.o] Error 1
63+
make[1]: *** [CMakeFiles/Makefile2:184: gui/qt/CMakeFiles/sonic-pi.dir/all] Error 2
64+
make: *** [Makefile:84: all] Error 2
65+
```
66+
validations:
67+
required: true
68+
- type: textarea
69+
id: other-details
70+
attributes:
71+
label: Other Details
72+
description: |
73+
You can drag related images into the description if you like.
74+
Feel free to provide any other relevant information about the issue if you have it, or can get it:
75+
- Ideas about possible root causes
76+
- Workarounds or potential solutions (or even better, send us a pull request!)
77+
- Etc...
78+
placeholder: "Example: Could this be related to X? Maybe we could add the foo software package as a dependency in BUILD-LINUX.md?"
79+
validations:
80+
required: false

Diff for: ‎.github/ISSUE_TEMPLATE/FEATURE-REQUEST-FORM.yml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: A feature request
2+
description: Describe a new feature or enhancement that you would like to see in Sonic Pi.
3+
labels: ["Feature Request"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Hello! Thank you for your interest in improving Sonic Pi.
9+
10+
The core Sonic Pi development team is fairly small and made up of volunteers (with the exception of Sam Aaron, who relies much on crowd-funding) so the more help we can receive to manage your ideas the better - help us to help you! Please follow the checklist below - that way you might not even need to raise a feature request after all :smile:
11+
- type: checkboxes
12+
id: prerequisites
13+
attributes:
14+
label: Prerequisites
15+
options:
16+
- label: I've searched the [Sonic Pi features project](https://github.com/orgs/sonic-pi-net/projects/1) for similar existing feature requests
17+
required: true
18+
- label: To the best of my knowledge, this feature would fit within the [project guidelines](https://github.com/sonic-pi-net/sonic-pi/blob/dev/CONTRIBUTING.md#project-and-development-process-guidelines)
19+
required: true
20+
- type: textarea
21+
id: description
22+
attributes:
23+
label: Feature Description
24+
description: |
25+
- Add as much detail as you can about your idea.
26+
- What problem would this feature solve, or benefit would it provide?
27+
- If it relates to new functions or changes in the language, give small examples of what you might write in Sonic Pi. Please use code formatting for the examples - if you're not sure how, please see the 'Code' examples at GitHub's [Mastering Markdown examples](https://guides.github.com/features/mastering-markdown/#examples).
28+
- You can drag related images into the description if useful - (for example, showing the design or layout of potential features or enhancements in the GUI).
29+
placeholder: "Example: I think a foo feature is useful for Sonic Pi because..."
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: other-details
34+
attributes:
35+
label: Other Details
36+
description: |
37+
Feel free to provide any other relevant information about the feature if you have it, or can get it, such as:
38+
- Places where you have seen similar features being used
39+
- Ideas about possible ways to build the feature
40+
- Etc...
41+
placeholder: "Example: We could build the foo feature by adding a bar to the baz panel..."
42+
validations:
43+
required: false

Diff for: ‎.github/ISSUE_TEMPLATE/RUNNING-ISSUE-FORM.yml

+117
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
name: A problem while Sonic Pi is running
2+
description: Sonic Pi starts up, but behaves unexpectedly during use.
3+
labels: ["triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Hello! Thank you for wanting to raise an issue for us, so that we know what's not working for you.
9+
10+
Sorry you're having issues while Sonic Pi is running! We're always working to improve its behaviour.
11+
12+
The core Sonic Pi development team is fairly small and made up of volunteers (with the exception of Sam Aaron, who relies much on crowd-funding) so the more help we can receive to manage, troubleshoot and hopefully fix your issues for you the better - help us to help you! Please follow the checklist below - that way you might not even need to raise an issue after all :smile:
13+
- type: checkboxes
14+
id: read-troubleshooting-guide
15+
attributes:
16+
label: Prerequisites
17+
options:
18+
- label: I've read the [Sonic Pi troubleshooting guide](https://github.com/sonic-pi-net/sonic-pi/wiki/Troubleshooting-Issues) and followed its suggestions where relevant
19+
required: true
20+
- type: dropdown
21+
id: sonic-pi-version
22+
attributes:
23+
label: Sonic Pi Version
24+
description: |
25+
What version of Sonic Pi were you running?
26+
(Was it a release version, Beta, or a version you compiled from source yourself?)
27+
options:
28+
- Self compiled
29+
- v4.0-Beta5
30+
- v4.0-Beta4
31+
- v4.0-Beta3
32+
- v4.0-Beta2
33+
- v4.0-Beta1
34+
- v3.3.1
35+
- v3.3
36+
- v3.2.2
37+
- v3.2.1
38+
- v3.2
39+
- v3.1
40+
- v3.0.1
41+
- v3.0
42+
- v2.11.1
43+
- v2.11
44+
- v2.10
45+
- v2.9
46+
- v2.8
47+
- v2.7
48+
- v2.6
49+
- v2.5
50+
- v2.4
51+
- v2.3
52+
- v2.2
53+
- v2.1.1
54+
- v2.1
55+
- v2.0.1
56+
- v2.0
57+
validations:
58+
required: true
59+
- type: input
60+
id: dev-commit
61+
attributes:
62+
label: Self compiled commit id
63+
description: "If you were using a version of Sonic Pi that you compiled yourself, what was the Git commit id of the code?"
64+
placeholder: "Example: 00f737e"
65+
validations:
66+
required: false
67+
- type: input
68+
id: os-version
69+
attributes:
70+
label: Operating System
71+
description: "What Operating System (and which version) were you using?"
72+
placeholder: "Example: Windows 10"
73+
validations:
74+
required: true
75+
- type: textarea
76+
id: repro-steps
77+
attributes:
78+
label: What were you doing when Sonic Pi behaved unexpectedly?
79+
description: |
80+
You can drag related images into the description if you like.
81+
If you were trying to run some code when Sonic Pi behaved unexpectedly, please share a _small_ code example here that demonstrates the unexpected behaviour. (The simpler it is the better).
82+
Please use code formatting for the example - if you're not sure how, please see the 'Code' examples at GitHub's [Mastering Markdown examples](https://guides.github.com/features/mastering-markdown/#examples).
83+
placeholder: "Example: I typed the following code into Sonic Pi, and then hit 'Run': `play foobar`"
84+
validations:
85+
required: true
86+
- type: textarea
87+
id: what-happened
88+
attributes:
89+
label: What happened?
90+
description: |
91+
You can drag related images into the description if you like.
92+
If Sonic Pi gave you an error, please share it below along with the stacktrace so that we can use it to investigate the cause.
93+
placeholder: "Example: Sonic Pi gave me an error. It said: Undefined variable or method `foobar` for Runtime:SonicPiLang, workspace_nine:1:in `block (2 levels) in __spider_eval'"
94+
validations:
95+
required: true
96+
- type: textarea
97+
id: expecting
98+
attributes:
99+
label: What were you expecting to happen instead?
100+
description: "You can drag related images into the description if you like"
101+
placeholder: "Example: I was expecting a sound to play."
102+
validations:
103+
required: true
104+
- type: textarea
105+
id: other-details
106+
attributes:
107+
label: Other Details
108+
description: |
109+
You can drag related images into the description if you like.
110+
Feel free to provide any other relevant information about the issue if you have it, or can get it:
111+
- Ideas about possible root causes
112+
- Links to the problematic commit or location in the source code on GitHub
113+
- Workarounds or potential solutions (or even better, send us a pull request!)
114+
- Etc...
115+
placeholder: "Example: Could this be related to X? Maybe it might be fixed by editing the foo file."
116+
validations:
117+
required: false

Diff for: ‎.github/ISSUE_TEMPLATE/STARTUP-ISSUE-FORM.yml

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
name: A Sonic Pi start up issue
2+
description: Sonic Pi doesn't start up successfully.
3+
labels: ["triage", "boot"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Hello! Thank you for wanting to raise an issue for us, so that we know what's not working for you.
9+
10+
Sorry you're having issues getting Sonic pi to start up! We're always working to improve the success rate.
11+
12+
The core Sonic Pi development team is fairly small and made up of volunteers (with the exception of Sam Aaron, who relies much on crowd-funding) so the more help we can receive to manage, troubleshoot and hopefully fix your issues for you the better - help us to help you! Please follow the checklist below - that way you might not even need to raise an issue after all :smile:
13+
- type: checkboxes
14+
id: read-troubleshooting-guide
15+
attributes:
16+
label: Prerequisites
17+
options:
18+
- label: I've read the [Sonic Pi troubleshooting guide](https://github.com/sonic-pi-net/sonic-pi/wiki/Troubleshooting-Issues) and followed its suggestions where relevant
19+
required: true
20+
- type: dropdown
21+
id: sonic-pi-version
22+
attributes:
23+
label: Sonic Pi Version
24+
description: |
25+
What version of Sonic Pi were you running?
26+
(Was it a release version, Beta, or a version you compiled from source yourself?)
27+
options:
28+
- Self compiled
29+
- v4.0-Beta5
30+
- v4.0-Beta4
31+
- v4.0-Beta3
32+
- v4.0-Beta2
33+
- v4.0-Beta1
34+
- v3.3.1
35+
- v3.3
36+
- v3.2.2
37+
- v3.2.1
38+
- v3.2
39+
- v3.1
40+
- v3.0.1
41+
- v3.0
42+
- v2.11.1
43+
- v2.11
44+
- v2.10
45+
- v2.9
46+
- v2.8
47+
- v2.7
48+
- v2.6
49+
- v2.5
50+
- v2.4
51+
- v2.3
52+
- v2.2
53+
- v2.1.1
54+
- v2.1
55+
- v2.0.1
56+
- v2.0
57+
validations:
58+
required: true
59+
- type: input
60+
id: dev-commit
61+
attributes:
62+
label: Self compiled commit id
63+
description: "If you were using a version of Sonic Pi that you compiled yourself, what was the Git commit id of the code?"
64+
placeholder: "Example: 00f737e"
65+
validations:
66+
required: false
67+
- type: input
68+
id: os-version
69+
attributes:
70+
label: Operating System
71+
description: "What Operating System (and which version) were you using?"
72+
placeholder: "Example: Windows 10"
73+
validations:
74+
required: true
75+
- type: textarea
76+
id: log-details
77+
attributes:
78+
label: Log file details
79+
description: |
80+
Please paste in the error report or log file details as outlined in the troubleshooting guide.
81+
If the `.sonic-pi/log` directory doesn't exist, then Sonic Pi probably doesn't even load far enough to be able to create it. Please tell us if this is the case!
82+
render: shell
83+
validations:
84+
required: true
85+
- type: textarea
86+
id: other-details
87+
attributes:
88+
label: Other Details
89+
description: |
90+
You can drag related images into the description if you like.
91+
Feel free to provide any other relevant information about the issue if you have it, or can get it:
92+
- Ideas about possible root causes
93+
- Links to the problematic commit or location in the source code on GitHub
94+
- Workarounds or potential solutions (or even better, send us a pull request!)
95+
- Etc...
96+
placeholder: "Example: Could this be related to X? Maybe it might be fixed by editing the foo file."
97+
validations:
98+
required: false

Diff for: ‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Hello! We're so glad you're interested in improving Sonic Pi.
2+
3+
The core Sonic Pi development team is fairly small and made up of volunteers (with the exception of Sam Aaron, who relies much on crowd-funding) so the more help we can receive to manage your pull requests the better! Please follow the checklist below - that way, the process of reviewing and potentially merging your contribution can be streamlined :smile:
4+
5+
- [ ] I've followed the project guidelines and ideal contribution process described in [CONTRIBUTING.md](https://github.com/sonic-pi-net/sonic-pi/blob/dev/CONTRIBUTING.md) where relevant.
6+
7+
## Type of change
8+
Please delete options that are not relevant.
9+
10+
- [ ] A bug fix
11+
- [ ] A new feature
12+
- [ ] A breaking change (a bug fix or new feature that would cause existing functionality to not work as expected)
13+
- [ ] A documentation update
14+
15+
## Description
16+
- Provide details about the update such as:
17+
- The reason for the change (provide context with links to discussions, GitHub issues, or other resources if available. **Note:** if this is a bug fix, you can link this PR to the bug so that it closes the bug when merged, by writing something in your PR comment like: fixes #1234 (where 1234 is the issue number)).
18+
- Where relevant, the reason for the particular way this change has been built.
19+
- Where relevant, a description of new behaviour.
20+
- Screenshots, animated gifs or videos, if the change affects the GUI.
21+
22+
## Other information
23+
Provide any other information that may be relevant to this PR.

0 commit comments

Comments
 (0)