mola/coding_guidelines

guidelines for a range of different programming languages - C++ | CMake

Coding Guidelines

Table of Contents

• Golden Rule
• Guides
• Inspiration
• License

This repository holds guidelines for a range of different programming languages. These guidelines consist of a style guide which defines the general source code format and naming of e.g. variables. Furthermore there is a programming guide which defines general rules, do's and don'ts to follow when writing source code.

The purpose of this repository is to help developers to achieve a more uniform style across code bases.

Golden Rule

Use common sense and be consistent. If your are extending, enhancing, or bug fixing existing source code, use the style that is already being used. This allows the source code to stay uniform and easy to follow. The point of having coding guidelines is to have a common base for writing code. It should help to provide a uniform code base across a project or organization/company and help other developers to understand the code base more efficiently.

Guides

For C++:

• Style Guide
• Programming Guide
• Tool Guide

For CMake:

• Style Guide
• Programming Guide

Inspiration

These coding guidelines were inspired by other already available guidelines namely:

For C++:

• LLVM Code Standards
• Google C++ Style Guide
• Chromium C++ style guide
• C++ Best Practices
• C++ Core Guidelines
• Rust Style Guidelines

For CMake:

• cmake-developer
• cmake-language
• KDE CMake Coding Style
• ROS CMake Coding Standards
• boost-cmake
• Modern CMake
• Effective Modern CMake
• Professional CMake

License

The project is licensed under the MIT license. See LICENSE for more information.