Rift Collapse

by nullptr* Studios

GDD: Word Document

Project conventions

Coding conventions

All variables MUST be named using camelCase, putting a _ prefix on private variables

Constant are named using SCREAMING_CASE

Functions and classes are named using PascalCase and MUST have proper documentation with parameters and returns (if not void)

When using Unity.Log("message");, a variable must be declared so it can be turn on or off. Variable MUST be declared like this:

#if UNITY_EDITOR
[Header("Debug")]
[SerializeField] private bool log = false;
#endif

// Example of Log
#if UNITY_EDITOR
if (log) Debug.Log("message");
#endif

Remember to put debug staff on compiler IFs so they aren't included on build

Git repository

Do NOT commit on main without an aproved PR

Create feature branches for the group of issues you are working on and link them to the branch

When creating an issue provide a description and select a tag and a milestone for it