Skip to content
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

GitHub - add issue and pull request templates #3069

Draft
wants to merge 6 commits into
base: dev
Choose a base branch
from

Conversation

ethancrawford
Copy link
Collaborator

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.

@ethancrawford
Copy link
Collaborator Author

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).

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.
What version of Sonic Pi were you running?
(Was it a release version, Beta, or a version you compiled from source yourself?)
options:
- Self compiled
Copy link
Contributor

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?

Copy link
Collaborator Author

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?

Copy link
Collaborator Author

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)

Copy link
Contributor

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.
@ethancrawford ethancrawford force-pushed the add_templates branch 2 times, most recently from 8779507 to 9b41e61 Compare April 29, 2022 13:05
@ethancrawford
Copy link
Collaborator Author

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants