From a6dbe9cd7edeced336e5882366c32d6112c647b6 Mon Sep 17 00:00:00 2001 From: mmoussallam Date: Sun, 24 May 2020 23:06:25 +0200 Subject: [PATCH] update contributing instruction set --- .github/CONTRIBUTING.md | 15 +++++++++++++++ README.md | 5 ++--- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 44fdd896..ee16fc50 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -8,3 +8,18 @@ Those are the main contributing guidelines for contributing to this project: - 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. - Any issue submitted which does not respect provided template, or lack of information, will be considered as invalid and automatically closed. + +## Get started + +In order to contribute, the safest is to create your [own fork of spleeter](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) first. The following set of commands will clone this new repository, create a virtual environment provisioned with the dependencies and run the tests (will take a few minutes): + +```bash +git clone https://github.com//spleeter +python -m venv spleeterenv && source spleeterenv/bin/activate +pip install -r requirements.txt && pip install pytest pytest-xdist +make test +``` + +You can then make your changes and experiment freely. Once you're done, remember to check that the tests still run. If you've added a new feature, add tests! + +Then finally, you're more than welcome to create a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) in **Spleeter** main repo. We will look at it as soon as possible and eventually integrate your changes in the project. diff --git a/README.md b/README.md index 496d6289..c4c774bb 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ If you use **Spleeter** in your work, please cite: ## License -The code of **Spleeter** is MIT-licensed. +The code of **Spleeter** is [MIT-licensed](LICENSE). ## Disclaimer @@ -91,10 +91,9 @@ As is commonly the case with open-source projects, there are multiple forks expo It appears that sometimes the shortcut command `spleeter` does not work properly on windows. This is a known issue that we will hopefully fix soon. In the meantime replace `spleeter separate` by `python -m spleeter separate` in command line and it should work. - ## Contributing -If you would like to participate in the development of **spleeter** your are more than welcome to do so. Don't hesitate to throw us a pull request and we'll do our best to examine it quickly. +If you would like to participate in the development of **spleeter** your are more than welcome to do so. Don't hesitate to throw us a pull request and we'll do our best to examine it quickly. Please check out our [guidelines](.github/CONTRIBUTING.md) first. ## Note