Developer’s Guide

This article describes the guidelines to be followed by developers working on SunPy. If you are thinking of contributing to SunPy please read the following carefully.

We currently recommend the Newcomers’ Guide as the place to start. This goes over the basics and has links to useful tutorials on git.

• Newcomers’ Guide
  • How to Contribute to SunPy
• Coding Standards
  • Language Standard
  • Coding Style/Conventions
  • Documentation and Testing
  • Data and Configuration
  • Standard output, warnings, and errors
  • Including C Code
• SunPy Documentation Rules
  • Overview
  • Sphinx
• Testing Guidelines
  • Testing Framework
  • Writing tests
• Pull Request Review and GitHub Members
  • Review Process
  • Continuous Integration
  • SunPy GitHub Groups
• Example Gallery
  • Contribution Guidelines
• Use of quantities and units
• Creating new SunPy Subclasses (Maps, TimeSeries)
  • Writing a new Instrument Map Class
  • Writing a new Instrument TimeSeries Class
• Workflow for Maintainers
  • Integrating changes via the web interface (recommended)
  • Integrating changes manually
  • Using Milestones and Labels
  • Using Projects
  • Updating and Maintaining the Changelog
  • Releasing SunPy
• Logging, Warnings, and Exceptions
  • Overview
  • Issuing Warnings
  • Raising Exceptions
• Global Settings
• Submodule and funding
  • Database
• Current status of sub-packages