Guidelines

Coding Style

• Follow the Google formatting style.
  • A .vscode/ is included in the repo for convenience
  • Remember to indent with 2 spaces
• Establish a consistent naming style.
  • snake_case for variables
  • camelCase for functions
  • PascalCase for classes and structs
  • ALL_CAPS for constants

Library Usage

• Because we use ncurses, no other I/O methods should be used for on-screen content.
  • Refer to https://stackoverflow.com/questions/40943743/getch-incompatible-with-display-function-in-linux-c for context

Project Structure

• Refer to this StackOverflow Answer

Commit Messages

• Guidelines for writing commit messages — https://github.com/joelparkerhenderson/git-commit-message
  Basically:
  • Begin with a verb
  • Use the imperative mood ("Add this", not "Added this" / "Adds this")
  • Be concise