Style Guides

• Coding Style Guide
  • Language standard
  • Coding Guidelines
    • Common
      • When in Rome
      • Commenting Out or Disabling Code
      • Auto-formatters
    • C++
      • Use C++ cstdint for Plain Old Data Types
      • Avoid top-level using namespace Statements in Headers
      • Classes / objects not exposed in a header should be in an anonymous namespace
      • Singleton use
      • Avoid Heap-based Resource Allocation and auto-resizing std containers
        • Alternatives
      • Prefer CopySpanToMutableSpan over memcpy when using spans
      • Prefer std::optional to CHIP implementation in newer code
    • Python
      • Type hints
      • Docstrings
      • mypy
• CHIP Makefile Style Guide
• Matter Documentation Style Guide
  • Location
  • Style
  • Links
  • Markdown guidelines
    • Headers
    • Command line examples
    • Terminal prompts
    • Commands and output
    • Code blocks in step lists
    • Inline code
    • Code Comments