NWChemEx Organization Conventions

The NWChemEx organization consists of a multitude of developers, spread out across a number of geographic locations. In an attempt to provide a unified development experience it is important that all developers strive to adhere to same conventions. The topics in this section cover conventions for writing code (i.e., coding conventions), and structuring a GitHub repository (i.e., repository conventions). For organization maintainers, some internal notes on organizational decisions can be found in the NWChemEx Google Drive folder.

Coding Conventions

• C++ Coding Conventions
  • Capitalization
• Python Coding Conventions
  • Code Formatting
  • Docstrings
• Using Doxygen in the NWChemEx Project
  • Intro To Doxygen
  • Minimal Documentation Standards
• Conventions for Writing reST Documentation
  • Style
  • Sections

Repository Conventions

• File Structure for NWChemEx Repositories
  • Why Do We Need to Standardize the Repository Layouts?
  • Files and Directories