Developer Guide

This section includes information for developers who want to contribute to the project. It includes information about the project structure, how to run the tests, and how to build the documentation. It also includes information about the project’s coding style and how to contribute to the project.

Project Structure

Tests

Documentation

This documentation is written as reStructuredText files .rst and converted to HTML websites files by Sphinx . The respective source files are located in PQ/docs/sphinx/src/. In order to compile the files locally you need a python environment in which the following packages are installed:

• Sphinx

• sphinx_sitemap

• breathe

• sphinx_rtd_theme

The project is built by running make html in the folder PQ/docs/sphinx/. The resulting website can be viewed by opening the file PQ/docs/sphinx/_build/html/index.html via your favorite browser.

How to Contribute

For any contributor willing to contribute to the project, it is important to understand the branching model used by the project. The project uses the Gitflow branching model. In order to contribute to the project please follow the following steps:

1. Fork the project on Github. (not necessary if you are a member of the project)

2. Clone your fork locally:

   $ git clone https://github.com/MolarVerse/PQ.git
   

3. Initialize git flow with the following settings (if not specified default settings are used)

   [master] main
   [develop] dev
   [version tag prefix] v
   

4. Create a feature branch for your contribution:

   $ git flow feature start <feature_branch_name>
   

5. Commit your changes to your feature branch and publish your feature branch:

   $ git add <files>
   $ git commit -m "commit message"
   $ git flow feature publish <feature_branch_name>
   

6. Create a pull request on Github.