Skip to content

CONTRIBUTING.rst

Latest commit

 

History

History
32 lines (20 loc) · 957 Bytes

CONTRIBUTING.rst

File metadata and controls

32 lines (20 loc) · 957 Bytes

Guidelines

Following C++ Core Guidelines where possible.

Naming and formatting is according to the Google C++ Style Guide. Use scons format.

New standards-compliant language features in C++14 are encouraged if they make the code safer, more maintainable and/or easier to understand/use. The only limiting factor is the oldest to be supported compiler versions.

Use scons {tidy,lint}; they can report many issues, but not all.

Organization

  • doc: Documentation.
    • api: API documentation, auto generated with scons doc.
  • include: Public interface headers.
  • src: Main binary and library sources. The modules (.cc, etc.) corresponding to public API headers go in here, as well as non-public headers and modules.
  • test: Unit tests.
  • third_party: Third-party dependencies.