################################
Developer guides
################################

Requirements for development
=============================================

* Ubuntu 20.x or above
* Python 3.8 or above (with pip and venv)

  * Recommended packages: python3.8, python3-pip and python3.8-venv

* Ruby 3.0 or above (with RubyGems and Ruby header files)

  * Recommended packages: ruby and ruby-dev

Branch policy
=============================================

For simplicity, we use the master branch as an unstable, development branch and do not have an additional stable branch.
Stable codes are marked as release tags.
If you need a stable code base, please check out one of the release tags.

How to setup environment for development
=============================================

.. code-block:: bash

    # Install platform tools
    sudo apt install cmake libgtest-dev libboost-all-dev nlohmann-json3-dev libasio-dev libtclap-dev graphviz

    # Clone mcdecoder
    git clone https://github.com/wildlarva/mcdecoder.git

    # Create virtual environment and switch to it
    cd mcdecoder
    python3.8 -m venv env
    source env/bin/activate

    # Install python tools and libraries
    pip install -r requirements.txt

    # Install ruby tools
    sudo gem install bundler
    bundle config set --local path gems
    bundle install

    # Install mcdecoder
    pip install -e .

After the installation, changes to the cloned directory will be
immediately reflected to mcdecoder you installed.

How to run tests for mcdecoder
=============================================

.. code-block:: bash

    # Switch to virtual environment
    cd <path-to-cloned-directory>
    source env/bin/activate

    # Run tests without coverage report
    pytest

    # Run tests with coverage report
    # The coverage report will be generated in the directory 'htmlcov'
    pytest --cov=src --cov-report html

How to run tests for generated decoders
=============================================

.. code-block:: bash

    # Switch to virtual environment
    cd <path-to-cloned-directory>
    source env/bin/activate

    # Run tests
    cmake -B build && cmake --build build && (cd build && ctest)

How to build documents
=============================================

.. code-block:: bash

    # Switch to virtual environment
    cd <path-to-cloned-directory>
    source env/bin/activate

    # Build documents
    make -C src_docs clean apply-html