Every major open-source project has its own style guide: a set of conventions (sometimes arbitrary) about how to write code for that project. It is much easier to understand a large codebase when all the code in it is in a consistent style.
"Style" covers a lot of ground, from "use camelCase for variable names" to "never use global variables" to "never use exceptions".
This project contains all the style guides we use at Leka to write code and/or documentation.
- - C++ Style Guide
- - License Guide
- - Swift Style Guide
- - Documentation Style Guide
Standing on the shoulders of giants...
A lot of content in these style guides has been happily inspired, copied and adapted from several sources. Here's the complete list of our inspirations:
- C++ Core Guidelines - Licensed under an MIT-style license
- Google C++ Style Guide - Licensed under a Creative Commons Attribution 3.0 Unported License
- Google Documentation Guide - Licensed under a Creative Commons Attribution 3.0 Unported License
The style guides in this project are licensed under the a CC BY-SA 4.0 - Creative Commons Attribution-ShareAlike 4.0 International License.
The code, repository structure, etc., are licensed under Apache-2.0.