Skip to content

Latest commit

 

History

History
21 lines (13 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

21 lines (13 loc) · 1.1 KB

TLDR: The expected, merge into main, reference issues in PRs.

Documentation

Out of source (non-inline) documentation such as design diagrams should be added to the docs folder as should images for readmes or anything else that is not within the docs folder.

Code

All source code should be in C++ following best practices guidelines where possible (such as avoiding new and delete).

Indentation should be done with spaces not tabs and a trailing new line should be added to the end of each file (this makes the diffs cleaner).

PRs

PRs should have a base branch of (and merge into) main with no merge conflicts. Please keep your branch as up to date as possible.

Your PR should include the issue number (e.g. "closes #1234"), there is no need to do so in commit messages.

Code of Conduct

Our code of conduct is "be kind to eachother" unless otherwise stated.