Contributing

• Code style
  • Introduction
  • Naming Conventions
    • File Names
    • Function Names
    • Variable Names
    • Member Names
    • Class/Struct Names
    • Alias/Typedef Names
    • Namespace Names
    • Example
  • Const Keyword
  • Code Format
  • Header Guards
• Git Workflow
  • Git Credentials
  • Downloading the Code
  • Branching Model
    • Feature Branches
    • Bugfix Branches
    • Release Candidate Branches
    • Hotfix Branches
    • Documentation Branches
  • Keeping Your Branch Current
  • Branching off of a Branch
  • Submitting a Pull Request
  • Keeping Submodules Current
  • Working on the Submodules
  • Resolving Submodule Changes In Primary Branch PRs
• Using Docker
• Sphinx Documentation
  • Generating the documentation
  • Documenting the code
• Doxygen Documentation
  • Accessing
    • Build locally
    • On readthedocs
  • Guidelines
    • What to document
    • How to document
  • Example
  • Current Doxygen
• Unit Testing
  • GEOSX Specific Recommendations
  • MPI
• Integrated Tests
  • About
  • Structure
  • Arguments
  • How to Run the Tests
  • Output Created By a Test
    • The RestartCheck File
    • The .diff.hdf5 File
  • The .ats File
  • Adding a Test
  • Rebaselining Tests
    • Tips
• Benchmarks
  • Running the benchmarks
  • Specifying a benchmark
    • The Run block
  • Adding a benchmark problem
  • Viewing the results
• Basic profiling with CALIPER
  • GEOSX/Caliper Annotation Macros
  • Configuring Caliper
  • Using Adiak
  • Using Spot
  • Opening Spot caliper files in Python