Developer’s Guide

This article describes the guidelines to be followed by developers working on this repository. If you are planning on contributing to this repository please read the following carefully. This guide borrows heavily from the one developed by the SunPy Project. It is consistent with the standards recommended by the Python in Heliophysics (PyHC).

The guidelines are

• Developer Environment
  • Conda Environment
  • Visual Studio Code
• Coding Standards
  • Language Standard
  • Coding Style/Conventions
  • Private code
  • Documentation and Testing
  • Data and Configuration
  • Standard output and errors
  • Logging and all other messages
  • Including C Code
• Testing Guidelines
  • Writing tests
• Documentation Rules
  • Overview
  • Sphinx
• Workflow for Maintainers
  • Integrating changes via the web interface (recommended)
  • Issue Milestones and Labels
  • Updating and Maintaining the Changelog
  • Releases