Development Guide

• How to Contribute
  • Impostor syndrome disclaimer
  • Contributing code or documentation to PlasmaPy
  • Towncrier changelog entries
    • Footnotes
• Community Code of Conduct
  • Our Pledge
  • Our Standards
  • Our Responsibilities
  • Scope
  • Enforcement
  • Attribution
• Installing PlasmaPy for Development
  • Obtaining PlasmaPy source code
  • Setting up an environment for development
    • Conda
    • Virtualenv
  • Installing your own dev version
• Code Development Guidelines
  • Coding Style
    • TL;DR: use pre-commit
    • PlasmaPy Code Style Guide, codified
  • Branches, commits, and pull requests
    • Commit Messages
  • Documentation
  • Warnings and Exceptions
  • Units
  • Equations and Physical Formulae
  • Angular Frequencies
  • Examples
  • Benchmarks
• Testing Guidelines
  • Motivation
  • Overview
  • Running Tests
    • Running tests on GitHub
    • Running tests from the command line
    • Running tests within Python
  • Writing Tests
    • Best practices for writing tests
    • Test organization and collection
    • Assert statements
    • Floating point comparisons
    • Testing warnings and exceptions
    • Test independence and parametrization
    • Pytest helpers
    • Fixtures
  • Code Coverage
    • Test coverage of contributed code
    • Generating coverage reports locally
    • Ignoring lines in coverage tests
  • Footnotes
• Documentation Guidelines
  • Building documentation
    • Using sphinx within the project
  • Docstrings
  • Narrative Documentation
• Release Guide
  • Release
  • Post-release
    • Compatibility with Prior Versions of Python, NumPy, and Astropy