Contributor Guide

Thank you for your interest in contributing to PlasmaPy! ✨ The future of the project depends on people like you, so we deeply appreciate it! 🌱

Please feel free to reach out to us during one of PlasmaPy’s community meetings. The PlasmaPy community abides by the Contributor Covenant Code of Conduct.

If you are becoming a first-time contributor, we recommend starting with:

Getting started

• Many Ways to Contribute
• Getting Ready to Contribute
• Code Contribution Workflow

After gaining some familiarity with the code contribution workflow, we suggest checking out:

Contributing to PlasmaPy

• Coding Guide
  • Introduction
  • Coding guidelines
  • Type annotations
  • Project infrastructure
  • Special function categories
  • Physics
  • Security policy
  • Performing releases
• Testing Guide
  • Summary
  • Introduction
  • Writing Tests
  • Best practices
  • Running tests
• Documentation Guide
  • Introduction
  • Markup Languages
  • Writing Documentation
  • Documentation guidelines
  • Sphinx
  • Building documentation
  • Troubleshooting
• Changelog Guide
  • Introduction
  • Adding a changelog entry
  • Changelog guidelines
  • Building the changelog
• Using pre-commit
  • Introduction
  • Running pre-commit locally
  • Troubleshooting pre-commit failures

The contributions are made to PlasmaPy’s GitHub repository. Thank you again!