-
Notifications
You must be signed in to change notification settings - Fork 34
guidelines
Bob Luppes edited this page Jun 3, 2023
·
1 revision
We follow a specific code style to maintain consistency throughout the library. The code formatting is specified as a set of clang-format
rules (more info here) and is enforced in the CI. Apart from formatting, please make sure your code adheres to the following:
- use snake case names for variables, functions, and classes.
- Follow descriptive and meaningful variable, function, and class names.
- Add appropriate comments to explain complex code sections or algorithms.
- Keep lines of code within a reasonable length (e.g., 80-120 characters).
- Follow existing naming conventions and code patterns.
In terms of coding style we aim to follow the C++ Core Guidelines.
Welcome to the Graaf wiki!
In case anything is unclear, or you encounter any other problems, please reach out on Discord or open an issue.