Developer’s Guide

This section contains the various guidelines to be followed by anyone working on sunpy.

Getting started

• Newcomers’ Guide
  • How to Contribute to sunpy
    • Not Code
    • Code
• Pull Request Check List
• Using conda for Development Dependencies
  • Normal Installation of sunpy
  • Editable Installation of sunpy

Conventions

• Coding Standards
• Testing Guidelines
• Documentation
• Example Gallery
• Pull Requests and GitHub Teams
• Use of quantities and units

Repo management

• Workflow for Maintainers
• Dependency Support Policy
• What runs on our Continuous Integration
• Making Changes to Released Versions
• Submodule and funding

Extending sunpy

• sunpy’s Public API
• Logging, Warnings, and Exceptions
• Tests using the Remote Data Manager