Contributing guide

Thank you for your interest in contributing to SPTK.

Any kinds of contributions are welcome.

Development

For the development of SPTK, you may need to install the following programs:

Then you can setup the development environment of SPTK by running

cd tools
make

SPTK provides a unit testing framework. Please perform unit testing before sending a pull request by running

make test

ClangFormat and cpplint are used to format source codes. Please also perform the formatting before sending a pull request by running

make format

You can generate the SPTK reference manual as follows:

make doc

The generated manual is in doc/_build/html/.