Skip to content

Commit 09d6573

Browse files
author
Ethan Manilow
committed
Adding license, readme, issue templates
1 parent f82da9d commit 09d6573

File tree

5 files changed

+117
-0
lines changed

5 files changed

+117
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
name: Bug report
3+
about: Found a bug in the tutorial? Report it here.
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
***BEFORE POSTING A BUG REPORT*** Please look through [existing issues (both open and closed)](https://github.com/source-separation/tutorial/issues?q=is%3Aissue) to see if it's already been reported or fixed!
11+
12+
13+
**What Section?**
14+
What's the title of the webpage or jupyter notebook where the bug occurs?
15+
16+
**Describe the bug**
17+
A clear and concise description of what the bug is.
18+
19+
20+
**Steps To Reproduce**
21+
<!--
22+
Example:
23+
```
24+
import nussl
25+
26+
# Load a file and do an STFT
27+
signal = nussl.AudioSignal('path/to/file.wav')
28+
signal.stft()
29+
30+
```
31+
If the code is too long, feel free to put it in a public gist and link
32+
it in the issue: https://gist.github.com
33+
-->
34+
35+
**Expected behavior**
36+
A clear and concise description of what you _expected_ to happen.
37+
38+
**What did happen**
39+
A clear and concise description of what _did_ happen.
40+
41+
**Audio output**
42+
If applicable, please link to audio examples that you uploaded to help us diagnose the issue.
43+
44+
**Screenshots**
45+
If applicable, add screenshots to help explain your problem.
46+
47+
**Software versions***
48+
<!--
49+
Please run the following Python code snippet and paste the output below.
50+
```
51+
import platform; print(platform.platform())
52+
import sys; print("Python", sys.version)
53+
import nussl; print("nussl", nussl.__version__)
54+
import scaper; print("scaper", scaper.__version__)
55+
```
56+
-->
57+
58+
**Additional context**
59+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Question
3+
about: Find something unclear? Ask here.
4+
title: ''
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
**What Section?**
11+
What webpage or jupyter notebook does this question pertain to?
12+
13+
**Your Question**
14+
Your question here.

‎.github/ISSUE_TEMPLATE/typo.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Typo
3+
about: Find a typo?
4+
title: ''
5+
labels: typo
6+
assignees: ''
7+
8+
---
9+
10+
**What Section?**
11+
What's the title of the webpage or jupyter notebook where the typo occurs?
12+
13+
**What does the website say?**
14+
15+
16+
**What SHOULD it say?**

‎LICENSE.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
3+
MIT License
4+
5+
Copyright (c) 2020 Ethan Manilow, Prem Seetharaman, Justing Salamon
6+
7+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
8+
9+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
10+
11+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
## Open-Source Tools & Data for Music Source Separation: A Pragmatic Guide for the MIR Practitioner
3+
4+
**By Ethan Manilow, Prem Seetharaman, and Justin Salamon**
5+
6+
This is the code repository for our [ISMIR 2020](https://ismir.github.io/ISMIR2020/)
7+
tutorial about Open Source tools for Source Separation. This repo contains the
8+
code to build the jupyter book website where the tutorial content is hosted.
9+
10+
11+
[Click here to visit the tutorial!](https://source-separation.github.io/tutorial/)
12+
13+
## Questions? Comments? Typos? Bugs? Issues?
14+
15+
Open a github issue [here](https://github.com/source-separation/tutorial/issues/new)
16+
17+

0 commit comments

Comments
 (0)