Skip to content

Latest commit

 

History

History
115 lines (79 loc) · 3.76 KB

CONTRIBUTING.md

File metadata and controls

115 lines (79 loc) · 3.76 KB
Raw

Contributing code

How to contribute

The preferred way to contribute to librosa is to fork the main repository on GitHub:

  1. Fork the project repository: click on the 'Fork' button near the top of the page. This creates a copy of the code under your account on the GitHub server.

  2. Clone this copy to your local disk:

       $ git clone [email protected]:YourLogin/librosa.git
   $ cd librosa

  3. Create a branch to hold your changes:

       $ git checkout -b my-feature

    and start making changes. Never work in the master branch!

  4. Work on this copy on your computer using Git to do the version control. When you're done editing, do:

       $ git add modified_files
   $ git commit

    to record your changes in Git, then push them to GitHub with:

       $ git push -u origin my-feature

Finally, go to the web page of the your fork of the librosa repo, and click 'Pull request' to send your changes to the maintainers for review. This will send an email to the committers.

(If any of the above seems like magic to you, then look up the Git documentation on the web.)

It is recommended to check that your contribution complies with the following rules before submitting a pull request:

  • All public methods should have informative docstrings with sample usage presented.

You can also check for common programming errors with the following tools:

  • Code with good unittest coverage (at least 80%), check with:

       $ pip install nose coverage
   $ nosetests --with-coverage --cover-package=librosa -w tests/

  • No pyflakes warnings, check with:

        $ pip install pyflakes
    $ pyflakes path/to/module.py

  • No PEP8 warnings, check with:

        $ pip install pep8
    $ pep8 path/to/module.py

  • AutoPEP8 can help you fix some of the easy redundant errors:

        $ pip install autopep8
    $ autopep8 path/to/pep8.py

Filing bugs

We use Github issues to track all bugs and feature requests; feel free to open an issue if you have found a bug or wish to see a feature implemented.

It is recommended to check that your issue complies with the following rules before submitting:

  • Verify that your issue is not being currently addressed by other issues or pull requests.

  • Please ensure all code snippets and error messages are formatted in appropriate code blocks. See Creating and highlighting code blocks.

  • Please include your operating system type and version number, as well as your Python, scikit-learn, numpy, and scipy versions. This information can be found by runnning the following code snippet:

import platform; print(platform.platform())
import sys; print("Python", sys.version)
import numpy; print("NumPy", numpy.__version__)
import scipy; print("SciPy", scipy.__version__)
import librosa; print("librosa", librosa.__version__)

Documentation

You can edit the documentation using any text editor and then generate the HTML output by typing make html from the docs/ directory. The resulting HTML files will be placed in _build/html/ and are viewable in a web browser. See the README file in the doc/ directory for more information.

For building the documentation, you will need sphinx, matplotlib, and numpydoc.

Note

This document was gleefully borrowed from scikit-learn.