Skip to content

Commit

Permalink
Add CONTRIBUTING.md and link it to Contributor Guide (PlasmaPy#2266)
Browse files Browse the repository at this point in the history
* Add initial CONTRIBUTING.md

* Add changelog entry

* Incorporate text from automated comments on PRs

* Update CONTRIBUTING.md

* Minor updates

* Update 2266.doc.rst

* Update CONTRIBUTING.md
  • Loading branch information
namurphy authored Sep 5, 2023
1 parent 4f0b09b commit 83ec415
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing to PlasmaPy

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

For more information on how to contribute, please check out our [**contributor guide**](https://docs.plasmapy.org/en/latest/contributing/index.html), which has information on:

- [Getting ready to contribute](https://docs.plasmapy.org/en/latest/contributing/getting_ready.html#getting-ready-to-contribute)
- The [code contribution workflow](https://docs.plasmapy.org/en/latest/contributing/workflow.html#code-contribution-workflow)
- Using [`astropy.units`](https://docs.plasmapy.org/en/latest/notebooks/getting_started/units.html#Using-Astropy-Units) and [`plasmapy.particles`](https://docs.plasmapy.org/en/latest/notebooks/getting_started/particles.html#Using-PlasmaPy-Particles)
- [Coding tips and guidelines](https://docs.plasmapy.org/en/latest/contributing/coding_guide.html#coding-guide)
- [Writing and building documentation](https://docs.plasmapy.org/en/latest/contributing/doc_guide.html#writing-documentation)
- [Writing and running tests](https://docs.plasmapy.org/en/latest/contributing/testing_guide.html#testing-guide)
- [Adding a changelog entry](https://docs.plasmapy.org/en/latest/contributing/changelog_guide.html#adding-a-changelog-entry) (needed except for minor changes)

You can also find us in our [**chat room**](https://docs.plasmapy.org/en/latest/contributing/coding_guide.html) or weekly [**community meetings**](https://www.plasmapy.org/meetings/weekly) & [**office hours**](https://www.plasmapy.org/meetings/office_hours).

We thank you once again!
2 changes: 2 additions & 0 deletions changelog/2266.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Added :file:`CONTRIBUTING.md` to PlasmaPy's GitHub repository. This
page refers contributors to PlasmaPy's |contributor guide|.

0 comments on commit 83ec415

Please sign in to comment.