Developer Guide

The Re::Solve Developer Guide documents software development processes followed by the Re::Solve project. The main goal of the guide is to ensure all project contributors understand the key elements of the processes so that they are consistently applied.

• Workflows
  • Git Branching
  • Creating a GitHub Issue
  • GitHub Pull Requests
    • Detail changes made in your PR in the description.
    • When reviewing a PR consider the following:
    • Minor concerns:
    • Major concern options:
    • Merging
• CMake Build System
• Spack Package
• Code Style
  • Error handling
  • Output
  • General naming conventions
  • Member variable naming
  • Function names
  • Class names
  • Enums (enumerated types)
  • Constants
  • Exceptions to naming conventions
  • Pointers and references
  • Indentation
  • Braces
  • Use of spaces and newlines
  • Using namespaces
  • Writing comments
• Writing Sphynx Documentation
  • Using Dev Containers for Writing Documentation
    • Prerequisites
    • Build Container
  • Devcontainer Configuration
  • GitHub Actions
  • GitLab Pipelines
  • Quick How-To guides