Skip to content

Latest commit

 

History

History
149 lines (110 loc) · 6.14 KB

README.md

File metadata and controls

149 lines (110 loc) · 6.14 KB
Raw

SpOCK

Spacecraft Orbital Characterization Kit

Website License: GPL v3 Lines of code

Installation

With Conan + CMake

1 - Get Conan and CMake

Conan is one of the leading options for cross-platform package manager for C/C++ projects. We chose it because it interfaces with CMake in a nice way. Conan will handle the dependencies and version conflicts management, and pass the paths of the installed dependencies to CMake so it can build the project.

CMake is the C++ build systems first choice for cross-platform development. Technically, CMake is a build system generator but the level of abstraction it offers allows us to consider it as a cross-platform build system. Users can build, test, and install packages with cmake and ctest commands.

💡 For devs, if you want more background on how Conan and CMake interact, check:

Configuring the dependencies 🔧

Lets start in the project root folder:

$ mkdir build && cd build
$ cmake -D CMAKE_BUILD_TYPE=Release \
        -D CMAKE_C_COMPILER=/usr/bin/gcc-10 \
        -D CMAKE_CXX_COMPILER=/usr/bin/g++-10 \
        ..

3 - Build, test, install 🚀

# Works on Linux, OSX, and Windows.
$ ncpus=$(python -c 'import multiprocessing as mp; print(mp.cpu_count())')
$ cmake --build . --parallel ${ncpus}
$ ctest --parallel ${ncpus}
$ cmake --build . --target install

Project API documentation

The project C++ library documentation is built with Doxygen and automatically published on Github Pages.

Project organization

  • src/ source for the main application (SpOCK program)
  • include/spock_lib interface for the spock_lib header-only library (*.h)
  • tests/ unit test framework
  • doc/ doxygen documentation

💡 for structure explanation, see this discussion on SO

Git branching model

We will use the following workflow:

  • main branch where the source code of HEAD always reflects a production-ready state.
  • develop branch where the source code of HEAD always reflects a state with the latest delivered development changes for the next release.
  • supporting branches: Next to the permanent branches main and develop, supporting branches have a limited time life. They aid parallel development between team members, ease tracking of features, prepare for production releases and assist in bug/fix tracking. The different types of branches we may use are:
    • feature branches
    • release branches
    • hotfix branches

💡 The rational of this workflow is described in this article.

alt text

Contributing

If you want to contribute to this project, the simplest way is to:

  • Fork it.
  • Clone it to your local system with git clone XXX.git
  • Make a new branch with git checkout -b feature
  • Make your changes with git commit -am "updated code for new feature"
  • Push it back to your repo git push
  • Click the Compare & pull request button.
  • Click Create pull request to open a new pull request.

Pull Request format

We use Release Drafter to automate the version labeling, feature tracking and project documentation. Please use informative labels during your PR drafting:

  • PRs with that belong to the Features category should be labeled with:
    • feature
    • enhancement
  • PRs that belong the Bug Fixes category should be labeled with:
    • fix
    • bugfix
    • bug
  • PRs that belong to the Maintenance category should be labeled
    • chore

### Conventional Commits Specification

The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of.

The commit message should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Defining commit <type>

  • fix: for a commit that patches a bug (this correlates with PATCH in Semantic Versioning).
  • feat: for a commit that introduces a new feature (this correlates with MINOR in Semantic Versioning).
  • chore: for a maintenance commit
  • docs: for a documentation update
  • test: for adding/removing/updating unit tests
  • refactor: for commits that do not add or remove any feature, but modifies the code design.

Automated testing

We use a Github Action described in .github/worflows/cmake.yml to automatically:

  • Install SpOCK dependencies
  • Configure CMake
  • Build the SpOCK executables
  • Test the project using ctest
  • Generate the Doxygen documentation
  • Deploy the documentation to the Project Github Page

How to store images and medias

For the use of media (images, videos etc) in the README, we created an empty media orphan branch where the media resources are uploaded to. This allows the master branch to be focused on code.

git checkout media
git add XXX.png
git commit -m "adding XXX.png to media branch"
git push origin media:media
git checkout main

In the README on branch main, the picture can then be referred as ![alt text](../media/XXXX.png?raw=true)

💡 This usage is documented here.