Describe how to add new module in contributor guide #3023
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
docs
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3023 +/- ##
=======================================
Coverage 94.61% 94.61%
=======================================
Files 107 107
Lines 9664 9664
Branches 1464 1464
=======================================
Hits 9144 9144
Misses 327 327
Partials 193 193 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
namurphy
commented
Jul 28, 2025
|
|
||
| To get a better idea of the steps necessary to add a new module, | ||
| check out a recent pull request that adds a new module (e.g., | ||
| :pr:`3021`). |
Member
Author
There was a problem hiding this comment.
Suggested change
| :pr:`3021`). | |
| :pr:`3021` or :pr:`3055`). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📚 This PR adds a section to the coding guide within the contributor guide with the necessary steps to add a new module to PlasmaPy.
There are a few
formulary-specific steps that need to be included. I'd like to add a little more discussion about adding narrative documentation (and potentially example Jupyter notebooks) too, though this may be a bit more nebulous and possibly subpackage-specific. 🤔This PR is inspired by the contributions by @Getahun-yw-Mahl and @josephrhsmith in #3021 to add
src/plasmapy/formulary/laser.py). 🌱 Many thanks!