Contributing

See the CONTRIBUTING.md document in our repository.

• Python Style Guide
  • Python Version
  • Pylint
  • File Layout
    • Executables
    • Legal Notice
    • Module Docstring
    • Tests
  • Coding Style
    • Indentation
    • Blank Lines
    • Imports
    • Quotes
    • Spaces
    • Compound Statements
  • Docstrings
  • Comments
    • Purpose of Comments
    • Commented Sections
    • Inline Comments
    • Comments in if/else blocks
  • Naming Conventions
    • Directory and File Names
    • Function, Method, and Instance Variable Names
    • Module-global Variables
    • Dummy Names
  • Interfacing with third party code
  • Programming Guidelines
    • Testable Code
    • Stay DRY
    • Classes
    • Data Member Initialization
    • Properties
    • List Comprehensions
    • String Formatting
    • Enums
• C++ Style Guide
  • Consistency Within A File
  • References
  • C++ Source Files
    • Introductory Section And Copyright Notices
    • Filenames
    • Naming Conventions
    • Indentation
    • The Header File
    • Class Definitions
    • Method Definitions
    • Example Header File
  • The CPP file
    • Variable Declarations
    • Comments in CPP files
  • Error Handling
    • Logging
    • Use of assert
    • Exceptions and Error Codes
    • Avoid static_cast
  • Memory and Resource Management
    • Memory Allocation
    • Resource Management
  • General principles
    • Factories
    • Passing resources around
    • boost::shared_ptr
  • Unit Tests
  • Documentation
    • Classes
    • Functions
  • Miscellaneous
    • Macros
    • Use of text
  • Use Of External Libraries
  • Cross Platform Coding
  • Operating System Dependencies
  • Specific Cross Platform Usage
  • Write Compiler-Agnostic Code
  • API Guidelines
    • API Design = Marketing
  • Naming conventions
    • Abbreviations
  • API Documentation
  • Error Handling
    • What errors should you check for?
    • Where should you check for errors?
    • How should you handle errors?
  • Miscellaneous
  • Node API Guidelines
  • General Guidelines
  • Specific Guidelines
  • Example Code Guidelines
    • General Guidelines
    • Specific Guidelines
• CMake Style Guide
  • Naming
  • Examples