DEVELOPMENT.md

Development Guide

This guide covers

• Updating the Documentation
• Releasing a New Version of the Python Module
• Local Development of the Package

Updating the Documentation

The documentation on ReadTheDocs.io will be automatically rebuilt and updated every time a push is made to the master branch.

Making Changes to the Documentation

The documentation can be found in the docs directory. The documentation articles are written in reStructuredText and the final result is generated using Sphinx.

See the docs/README.md for instructions on how to locally build and test the documentation.

Releasing a New Version of the Python Module

A new version of the Python module will be automatically released on PyPi when a new Release is made on GitHub.

Pre-requisites

• Update the version number in TauLidarCommon/__version__.py
• Create a Release in the GitHub Repo

Versioning

Version numbers will follow the MAJOR.MINOR.PATCH syntax. More info here.

Release Notes

Each release must be accompanies with changelog notes outlining what's new. This includes:

• Features
• Bug fixes
• Performance improvements
• Etc

Local Development of the Package

Will use Virtual Environments and PIP Editable Installs to locally install the package for development purposes

In your testing directory, setup the virtual environment (only needs to be done once):

python3 -m venv .

Activate virtual environment:

source bin/activate

Local install of the tau-lidar-common package:

python -m pip install -e /path/to/tau-lidar-common

Now run your testing program.

Any edits to the tau-lidar-common package source code in /path/to/tau-lidar-common will be reflected when the testing program is run again