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.

Setting Up a Development Environment

If you’d like to learn how to setup your development environment, please see the Developer Environment section.

Following Code Standard and Style Guidelines

For guidelines on how to write code for this repository, please see the Coding Standards section.

Testing and Continuous Integration

For guidelines on how testing is run on the built container images as well as how the continuous integration is setup, please see the CI/CD Pipeline and Testing Guidelines section.

Documentation Maintenance

For guidelines on how to maintain the documentation, please see the Documentation Rules section.

Maintainer Workflow

For guidelines on how to contribute and maintain this repository, please see the Workflow for Maintainers section.

Contents:

• Developer Environment
  • Understanding the Basics
  • Setting Up Your Development Environment
• Workflow for Maintainers
  • Integrating changes via the web interface (recommended)
    • When to remove or combine/squash commits
    • When to rebase
    • A few commits
    • A long series of commits
    • Check the history
    • Push to open pull request
  • IOssue Milestones and Labels
  • Updating and Maintaining the Changelog
  • Releases
• Coding Standards
  • Language Standard
  • Coding Style/Conventions
  • Testing
    • Automate
    • By Hand
  • Documentation
• Documentation Rules
  • Overview
    • Referring to other code
    • Project-specific Rules
  • Sphinx
    • Usage and Building the documentation
      • HTML
      • PDF
• CI/CD Pipeline and Testing Guidelines
  • Writing tests
    • Where to put tests
    • schemaVersion
    • commandTests
    • fileExistenceTests
    • More options available
    • Bugs Testing
  • CI/CD Pipeline
    • Pull Request Pipeline
    • Merge Pipeline
    • Diagram of Full CI/CD Pipeline
    • Manually initiating the CI/CD Pipeline