[Content] 101-3: Source Organization

[karnkaul]

Expand the 101 series by adding a post about managing a project's source tree.

Salient points to cover:

• Pitchfork layout (quick brief + hyperlink)
• Include paths and directories
  • Why #include <> and not #include ""
  • How to add include paths for a CMake target
  • How to organize include paths and subdirectories for modular and portable #includes
• Why lowercase filenames
• .gitignore setup
  • out/, build/, .vscode/, .cache/ etc
  • compile_commands.json
• Branching strategies
  • Continuous vs versioned software; C++ projects are the latter
  • "The" git branching model vs GitHub flow
  • All branches must converge to a "common future"; only exception is automated branches like gh-pages (not applicable for C++ projects)
  • Minimize number of persistent branches
  • Use short lived feature / topic branches for development
  • Use tags to mark versions on commits (useful for releases and libraries)

[hentai-chan]

I would add the following, too:

• git submodules
• clang-format (think this has been mentioned elsewhere but one reason to repeat this point would be that this way, the article could stand well on its own)
• DevOps (nice to have checks for PRs in group projects)
• DevSecOps (what I am currently writing about, but some lessons also extend to C++ / other languages in general)