Skip to content

Commit

Permalink
update contributing instruction set
Browse files Browse the repository at this point in the history
  • Loading branch information
mmoussallam committed May 24, 2020
1 parent 7630f29 commit a6dbe9c
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
15 changes: 15 additions & 0 deletions .github/CONTRIBUTING.md
Expand Up @@ -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/<your_name>/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.
5 changes: 2 additions & 3 deletions README.md
Expand Up @@ -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

Expand All @@ -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

Expand Down

0 comments on commit a6dbe9c

Please sign in to comment.