CONTRIBUTING.md

Contributing

⚠ This document is a work in progress.

[TOC]

Introduction {#Introduction}

To be completed...

Guidelines {#Guidelines}

Codebase {#Codebase}

C++ {#C}

Include order from specific to generic:

#include <OpenSpaceToolkit/Simulation/Orbit.hpp>

#include <OpenSpaceToolkit/Core/Type/Integer.hpp>
#include <OpenSpaceToolkit/Core/Utility.hpp>

#include <map>
#include <string>

References:

• https://stackoverflow.com/questions/2762568/c-c-include-file-order-best-practices
• https://blog.kowalczyk.info/article/qg/order-of-include-headers-in-cc.html

Python {#Python}

To be completed...

Version Control {#Version}

Rules {#Rules}

To be completed...

Commit Messages {#Commit}

How to Write a Git Commit Message

Use active form (Do something).

Prefix commit messages using the following tags:

• [feature]
• [fix]
• [misc]

Examples:

[feature] Implement high fidelity orbit propagator

[fix] Segmentation fault when fetching ephemeris data

Code of Conduct {#CodeOfConduct}

To be completed...