You are viewing the latest unreleased documentation v3.1.dev0. You may prefer a stable version.

Contributing to the Code Base

• Code Formatting
• Docstrings
  • Single-Line Docstrings
  • Multi-Line Docstrings
    • Description
    • Sample Multi-Line Docstring
  • Documenting Classes
    • Attribute and Property Docstrings
• reST Quick Start
  • Creating Links
• Deprecations
  • Adding a Deprecation
    • Removing a Public API
    • Changing a Default
  • Removing a Deprecation
    • Removing a Public API
    • Changing a Default
• Testing
  • Test Categories
    • Unit Tests
    • Integration Tests
  • Graphics Tests
    • Challenges
    • Testing Strategy
    • Reviewing Failing Tests
    • Add Your Changes to Iris
  • Running the Tests
    • Using setuptools for Testing Iris
    • Using Nox for Testing Iris
  • Continuous Integration (CI) Testing
    • Cirrus-CI
    • SciTools CLA Checker
    • pre-commit CI