-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move development info to contributing (#446)
Co-authored-by: Rachel Bittner <[email protected]>
- Loading branch information
1 parent
dc881cc
commit b0a6fd9
Showing
2 changed files
with
23 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,26 +5,39 @@ Contributing | |
############ | ||
|
||
We encourage contributions to mirdata, especially new dataset loaders. To contribute a new loader, follow the | ||
steps indicated below and create a Pull Request (PR) to the github repository. | ||
steps indicated below and create a Pull Request (PR) to the github repository. For any doubt or comment about | ||
your contribution, you can always submit an issue or open a discussion in the repository. | ||
|
||
- `Issue Tracker <https://github.com/mir-dataset-loaders/mirdata/issues>`_ | ||
- `Source Code <https://github.com/mir-dataset-loaders/mirdata>`_ | ||
|
||
|
||
Installing and running tests | ||
############################# | ||
Installing mirdata for development purposes | ||
########################################### | ||
|
||
To install ``mirdata`` for development purposes: | ||
|
||
First, clone the repository from github: | ||
- First run: | ||
|
||
.. code-block:: bash | ||
.. code-block:: console | ||
git clone https://github.com/mir-dataset-loaders/mirdata.git | ||
- Then, after opening source data library you have to install the dependencies for updating the documentation | ||
and running tests: | ||
|
||
.. code-block:: console | ||
git clone [email protected]:mir-dataset-loaders/mirdata.git | ||
pip install . | ||
pip install .[tests] | ||
pip install .[docs] | ||
pip install .[dali] | ||
We recommend you install `pyenv <https://github.com/pyenv/pyenv#installation>`_ to manage your Python versions | ||
and install all ``mirdata`` requirements. You will want to install the latest versions of Python 3.6 and 3.7. | ||
Once ``pyenv`` and the Python versions are configured, install ``pytest``. Finally, run : | ||
We recommend to install `pyenv <https://github.com/pyenv/pyenv#installation>`_ to manage your Python versions | ||
and install all ``mirdata`` requirements. You will want to install the latest versions of Python 3.6 and 3.7. | ||
Once ``pyenv`` and the Python versions are configured, install ``pytest``. Make sure you installed all the pytest | ||
plugins to automatically test your code successfully. Finally, run: | ||
|
||
.. code-block:: bash | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters