Tutorials

This section provides a brief introduction to the tutorials.The following pages will cover the main all necessary topics for using the scaffold to ease a complete C++ development process. From the initial phases of project initiation and quick validation, to maintenance phase of the code quality and testing processes, to packaging the software, the tutorials provide a step-by-step guide to help developers get started with the scaffold. We aim to provide a comprehensive and practical guide for modern C++ developers on open-source platforms like GitHub and GitLab, from novice to expert, who want to build reliable and maintainable software.

Note

Best practices can vary based on specific circumstances. We are open to comments and suggestions to refine the approach.

Table of Contents

• Project Management
  • Prerequisites
  • Creation
  • Configuration
    • Protection
    • Merge Strategy
    • Pages
    • Codecov
    • CodeQL
    • Release
    • Renovate
  • Update
• Development Environment
  • Prerequisites
  • Setup-cpp
  • Devcontainer for quick start
• Building
  • Prerequisites
  • General Build Process
  • Triplet Presets
    • With Presets
    • Without presets
  • Available Targets in the Project
  • Export Mode
    • Usage
    • Offline Build
• Dependencies
  • Dependencies Sources
  • Using Vcpkg
  • Using Conan
  • Using CPM
• Commit Convention
  • For Release Automation
    • Commit Message Format
    • Commit Message Types
  • For Semantic Versioning
• Security
  • Best Secure Coding Practices
  • Warnings Detectors
  • Protection Mechanisms from OS
  • Use Latest Compiler and OS Updates
  • Protection Tests