Skip to content

CONTRIBUTING.rst

Latest commit

 

History

History
173 lines (129 loc) · 5.98 KB

CONTRIBUTING.rst

File metadata and controls

173 lines (129 loc) · 5.98 KB

Contributing

If you want to contribute to pyroomacoustics and make it better, your help is very welcome. Contributing is also a great way to learn more about the package itself.

Ways to contribute

  • File bug reports
  • Improvements to the documentation are always more than welcome. Keeping a good clean documentation is a challenging task and any help is appreciated.
  • Feature requests
  • If you implemented an extra DOA/adaptive filter/beamforming algorithm: that's awesome! We'd love to add it to the package.
  • Suggestion of improvements to the code base are also welcome.

Coding style

We try to stick to PEP8 as much as possible. Variables, functions, modules and packages should be in lowercase with underscores. Class names in CamelCase.

We use pre-commit to manage code quality hooks, including Black for formatting and isort for sorting imports. The hooks will be automatically checked during pull requests.

To set up the pre-commit hooks locally:

pip install pre-commit
pre-commit install

Once installed, the hooks will run automatically on every commit. You can also run them manually on all files:

pre-commit run --all-files

Documentation

Docstrings should follow the numpydoc style.

We recommend the following steps for generating the documentation:

  • Create a separate environment, e.g. with Anaconda, as such: conda create -n mkdocs37 python=3.7 sphinx numpydoc mock sphinx_rtd_theme sphinxcontrib-napoleon tabulate
  • Switch to the environment: source activate mkdocs37
  • Navigate to the docs folder and run: ./make_apidoc.sh
  • The materials database page is generated with the script ./make_materials_table.py
  • Build and view the documentation locally with: make html
  • Open in your browser: docs/_build/html/index.html

It can be convenient to develop and run tests locally. In contrast to only using the package, you will then also need to compile the C++ extension for that.

Requirements: - C++ compiler: GCC or Clang on Mac/Linux, Visual C++ 14.0+ on Windows. - CMake (version 3.10 or higher). - pre-commit

  1. Get the source code.

    git clone git@github.com:LCAV/pyroomacoustics.git

    External dependencies (Eigen, nanoflann, pybind11) are automatically downloaded during the build process using CMake's FetchContent.

  2. Install in editable mode.

    Editable mode is recommended for local development as it correctly links the source files and compiled extensions.

    pip install -U -e .

    The build process uses CMake to compile the C++ extensions. The -U flag ensures that the package is upgraded to the latest version. Make sure to re-run this command when changing the C++ code.

    On macOS, if necessary, you can set the deployment target:

    MACOSX_DEPLOYMENT_TARGET=11.0 pip install -U -e .

  3. Verify the installation.

    python -c "import pyroomacoustics as pra; print(pra.__version__)"

Unit Tests

As much as possible, for every new function added to the code base, add a short test script in the top-level tests/ directory. The names of the script and the functions running the test should be prefixed by test_. The tests are started by running pytest at the root of the package.

How to make a clean pull request

Look for a project's contribution instructions. If there are any, follow them.

  • Create a personal fork of the project on Github.
  • Clone the fork on your local machine. Your remote repo on Github is called origin.
  • Add the original repository as a remote called upstream.
  • If you created your fork a while ago be sure to pull upstream changes into your local repository.
  • Create a new branch to work on! Branch from develop if it exists, else from master.
  • Implement/fix your feature, comment your code.
  • Follow the code style of the project, including indentation.
  • If the project has tests run them!
  • Write or adapt tests as needed.
  • Add or change the documentation as needed.
  • Squash your commits into a single commit with git's interactive rebase. Create a new branch if necessary.
  • Push your branch to your fork on Github, the remote origin.
  • From your fork open a pull request in the correct branch. Target the project's develop branch if there is one, else go for master!
  • …
  • If the maintainer requests further changes just push them to your branch. The PR will be updated automatically.
  • Once the pull request is approved and merged you can pull the changes from upstream to your local repo and delete your extra branch(es).

And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.

How to deploy a new version to pypi

  1. git checkout pypi-release
  2. git merge master
  3. Edit CHANGELOG.rst as follows
    • Add new title X.Y.Z_ - YEAR-MONTH-DAY under Unreleased, add "Nothing yet" in the unreleased section.
    • Edit appropriately the list of links at the bottom of the file.
  4. git commit
  5. Tag the new version (e.g., vX.Y.Z). Version strings are automatically generated from git tags using setuptools_scm.
  6. git push origin vX.Y.Z
  7. git push
  8. git checkout master
  9. git merge pypi-release
  10. git push origin master

Reference

This guide is based on the nice template by @MarcDiethelm available under MIT License.