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
• Coding Standards
  • HERMES Instrument Standards
• Testing Guidelines
  • Writing tests
• Documentation Rules
  • Overview
  • Sphinx
• Workflow for Maintainers
  • Testing Calibration Code via Pull Requests
  • Integrating changes via the web interface (recommended)
  • IOssue Milestones and Labels
  • Updating and Maintaining the Changelog
  • Releases
• Global Settings