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 those developed by the SunPy Project and is generally consistent with this community-developed approach.

• Developer Environment
  • Visual Studio Code
• Coding Standards
  • Language Standard
  • Coding Style/Conventions
  • Private code
  • Utilities
  • Formatting
  • Documentation and Testing
  • Data and Configuration
  • Standard output, warnings, and errors
  • Including C Code
• Testing Guidelines
  • Writing tests
• Downstream Integration Testing
  • Overview
  • When the workflow runs
  • Running downstream tests on a PR
  • Adding or updating a downstream package
  • Best practices
• Documentation Rules
  • Overview
  • Sphinx
• Workflow for Maintainers
  • Integrating changes via the web interface (recommended)
  • IOssue Milestones and Labels
  • Updating and Maintaining the Changelog
  • Releases
• Global Settings