Skip to content

Latest commit

 

History

History
47 lines (38 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

47 lines (38 loc) · 1.03 KB

Contributing guide

Thank you for your interest in contributing to SPTK.

SPTK is currently under construction. Any kinds of contributions are not welcome at the moment.

Development

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

  • Bison
  • ClangFormat
  • CMake 3.3+
  • flex 2.6.3
  • Python 3.6+
  • Valgrind
  • Virtualenv

Then you can setup the development environment of SPTK by running

cd tools
make

Unit testing

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

make test

Source code formatting

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

make format

Document generation

You can generate the SPTK reference manual as follows:

make doc

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