software-development.md

Software engineering

General

• Robert Ramey “How to Write Effective Documentation for C++ Libraries...” (CppCon'17)
  • use short comments within the code
  • external documentation for public library interfaces only
  • SGI STL Documentation as a good old example
• Logging in Python like a PRO 🐍🌴 - actually half of the article is rather language-agnostic
• Classic SE Mistakes by Steve McConnell

Git

• How to Write a Git Commit Message
• Git Organized: A Better Git Flow
• Learn to use email with git!

C++

• A Tour of C++, a book by Bjarne Stroustrup (scroll it down for links to draft PDFs)
• C++ reference
• An Introduction to Modern CMake
• CMake - Introduction and best practices - slides by Daniel Pfeifer

Python (3)

• Documenting code
• Python design patterns
• How to practice Pandas