From 73ed21391ab526ac655b1b4909cecd08fe027671 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?F=C3=A9lix=20Voituret?= <fvoituret@deezer.com>
Date: Mon, 4 Nov 2019 13:56:24 +0100
Subject: [PATCH] docs: add contributing guideline docs: add issue and PR
 templates

---
 .github/CONTRIBUTING.md          |  9 +++++++++
 .github/ISSUE_TEMPLATE.md        | 33 ++++++++++++++++++++++++++++++++
 .github/PULL_REQUEST_TEMPLATE.md | 13 +++++++++++++
 3 files changed, 55 insertions(+)
 create mode 100644 .github/CONTRIBUTING.md
 create mode 100644 .github/ISSUE_TEMPLATE.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..5dc264e
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,9 @@
+# How-to contribute
+
+Those are the main contributing guidelines for contributing to this project:
+
+- Verify that your contribution does not embark proprietary code or infringe any copyright of any sort.
+- Avoid adding any unnecessary dependencies to the project, espcially of those are not easily packaged and installed through `conda` or `pip`.
+- Python contributions must follow the [PEP 8 style guide](https://www.python.org/dev/peps/pep-0008/).
+- Use [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) mechanism and please be patient while waiting for reviews.
+- Remain polite and civil in all exchanges with the maintainers and other contributors.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..3a77802
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,33 @@
+# ISSUE-TITLE
+
+## Describe the bug/issue
+
+First tell us:
+
+- which part of Spleeter is it about (Doc, Scripts, Docker, etc )?
+- what type of issue is it ? ( BUG / QUESTION / FEATURE REQUEST ?) ..
+
+Then give us a clear and concise description of the issue.
+
+## To reproduce
+
+Steps to reproduce the behavior :
+
+1. Install with '...'
+2. Run '....'
+3. See error
+
+## Terminal output
+
+Share what your terminal says when you run the script.
+
+## Your Setup
+
+In particular:
+
+- OS: [Windows/Linux/Mac/Other]
+- Execution Environment :[Conda/Pip/Other] and versions
+
+## Additional context
+
+Add any other context about the problem here, references, cites, etc..
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..bdb95c9
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,13 @@
+# [Spleeter-XXXX] - pull request title
+
+## Description
+
+A few sentences describing the overall goals of the pull request's commits.
+
+## How this patch was tested
+
+You tested it, right?
+
+## Documentation link and external references
+
+Please provide any info that may help us better understand your code.