CircleCI	VSTS

Doghook

Making code changes

All code changes need to be made added to a new branch that follows the formula <username>/<subject> e.g. marc3842h/circleci-artifacts. Once you are done with your code changes make a pull request on github, add @josh33901 or @marc3842h as a reviewer. The pull request will make sure that it compiles on both platforms before it is allowed to be merged into the codebase.

Code should be clang-formatted before a pull request is made (otherwise it is a valid reason to decline a pull request).

C++ guidelines

• Code should be formatted with the .clang-format in the root of the project (maybe make this a git hook??)

• Use almost always auto:

  This means using auto where the type is already observable. Examples are:

  auto v = *reinterpret_cast<LongAndAnnoyingType **>(vraw);
  auto f(int a, int b) {
      return a + b;
  }
  

  For functions that have a seperate declaration and definition do not use auto.

• Types are UpperCamelCase 🐫, whilst everything else is lower_snek_case 🐍. Do not use hungarian notation or m_ for members or any similar prefix suffix system (_t for types).

• We are using C++ which means you dont need to do stupid C style struct typedef tricks. Remove these.

Copy-pasted code blocks should be updated to match these guidelines to preserve consistency across the codebase!