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

Add GitHub issue & PR templates #3017

Closed
wants to merge 10 commits into from
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!--- Provide a general summary of the issue in the Title above -->

## Environment
* SuperCollider version:
* Operating system and version:
<!--- Include any other relevant details about your environment (Qt version, audio driver, etc.) -->

## Expected Behavior
<!--- If you're describing a bug, tell us what should happen -->
<!--- If you're suggesting a change/improvement, tell us how it should work -->

## Current Behavior
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
<!--- If suggesting a change/improvement, explain the difference from current behavior -->

## Steps to reproduce (for bugs)

```supercollider
// Please paste SuperCollider code here.
// Try to make your example as minimal as possible.
```

## Error message (for bugs)

```
// Please paste any error messages here in their entirety.
// If this is a SuperCollider error message, include the full stack trace.
// Link to a Gist (https://gist.github.com) if the message is long.
```

<!--- Thanks for contributing! -->
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!--- Provide a general summary of your changes in the title above -->

## Purpose and Motivation

<!--- Please describe the purpose and motivation of the pull request. -->
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## Types of changes

<!--- What types of changes does your pull request introduce? Put an `x` in all the boxes that apply: -->
- [ ] Documentation (non-code change which corrects or adds documentation for existing features)
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Checklist
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The checklist is to fill out over the course of the PR, no? Or what is the intention of having checkboxes to tick?


- [ ] All tests are passing
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we ask for tests, there should be a link on how to do the tests (since this is not on per default in vanilla SC)

- [ ] If necessary, new tests were created to address changes in PR (and tests are passing)
- [ ] Updated documentation, if necessary
- [ ] This PR is ready for review

<!--- If any work remains to be done, please give a brief description here. -->
<!--- Consider providing a todo-list so we can easily track completion progress. -->

<!--- Thanks for contributing! -->