-
-
Notifications
You must be signed in to change notification settings - Fork 953
GitHub - add issue and pull request templates #3069
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
Conversation
Here are the issue template forms and a pull request template as discussed previously.
(This includes the issue template form for compilation issues as later suggested by @samaaron).
9b8f001 to
d9055dd
Compare
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.
d9055dd to
bfc0ee3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will these lists need to be updated manually each time a new release is made? Might it be worth adding an "Other" option in case that ever gets forgotten?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure. Do you think there'd be any drawback to having it as a plain text input?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(The Sonic Pi version input that is)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I think plain text would be fine, and it would be less work from a maintenance point of view.
This will reduce maintenance burden when new releases or Betas are produced.
8779507 to
9b41e61
Compare
9b41e61 to
d792d58
Compare
For reference: I created a dummy repo with the above issue templates actually available for testing.
See: https://github.com/ethancrawford/test-templates/issues.
I'm calling this ready as soon as I have had agreement that my updates to the troubleshooting guide (now guides) on my copy of the Sonic Pi wiki are good enough to merge to the upstream copy (and therefore I can re-link references to them in the above templates).
The phrasing was changed slightly, and the links to the GitHub docs for how to use code formatting have been updated.
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.