|
1 | | -title: Contribute to PlasmaPy |
| 1 | +title: Contributing to PlasmaPy |
2 | 2 | slug: contribute |
3 | 3 |
|
4 | 4 | # Contributing to PlasmaPy |
5 | 5 |
|
6 | | -There are numerous ways to contribute to PlasmaPy, including by |
7 | | -providing code and documentation, suggesting and discussing ideas, |
8 | | -submitting issues and bug reports, and engaging the broader plasma |
9 | | -physics community. |
10 | | - |
11 | | -**Imposter syndrome disclaimer**: We want your help. No, really. |
12 | | - |
13 | | -There may be a little voice inside your head that is telling you that you're not |
14 | | -ready to be an open source contributor; that your skills aren't nearly good |
15 | | -enough to contribute. What could you possibly offer a project like this one? |
16 | | - |
17 | | -We assure you - the little voice in your head is wrong. If you can write code at |
18 | | -all, you can contribute code to open source. Contributing to open source |
19 | | -projects is a fantastic way to advance one's coding skills. Writing perfect code |
20 | | -isn't the measure of a good developer (that would disqualify all of us!); it's |
21 | | -trying to create something, making mistakes, and learning from those |
22 | | -mistakes. That's how we all improve, and we are happy to help others learn. |
23 | | - |
24 | | -Being an open source contributor doesn't just mean writing code, either. You can |
25 | | -help out by writing documentation, tests, or even giving feedback about the |
26 | | -project (and yes - that includes giving feedback about the contribution |
27 | | -process). Some of these contributions may be the most valuable to the project as |
28 | | -a whole, because you're coming to the project with fresh eyes, so you can see |
29 | | -the errors and assumptions that seasoned contributors have glossed over. |
30 | | - |
31 | | -*This disclaimer was originally written by |
32 | | -[Adrienne Lowe](https://github.com/adriennefriend) for a |
33 | | -[PyCon talk](https://www.youtube.com/watch?v=6Uj746j9Heo), and was adapted by |
34 | | -[yt](https://github.com/yt-project/yt) in their README file based on its use |
35 | | -in the README file for the [MetPy project](https://github.com/Unidata/MetPy). |
36 | | -It was then adapted by PlasmaPy.* |
37 | | - |
38 | | -## Sharing ideas |
39 | | - |
40 | | -There are several methods of communication that are being used in the |
41 | | -early stages of PlasmaPy development: |
42 | | - |
43 | | -* [Signing up for the PlasmaPy email |
44 | | - list](https://groups.google.com/forum/#!forum/plasmapy) will allow |
45 | | - you to participate in broader discussions and keep up with the |
46 | | - latest developments. |
47 | | - |
48 | | -* The [PlasmaPy repository on |
49 | | - GitHub](https://github.com/PlasmaPy/plasmapy) is the best place to |
50 | | - [submit issues](https://github.com/PlasmaPy/plasmapy/issues) and |
51 | | - review [pull requests](https://github.com/PlasmaPy/plasmapy/pulls). |
52 | | - |
53 | | -* The PlasmaPy [Matrix](https://app.element.io/#/room/#plasmapy:openastronomy.org) or |
54 | | - [Gitter](https://gitter.im/PlasmaPy/Lobby) joint channel |
55 | | - is a great place to have informal conversations, coordinate efforts, |
56 | | - and share ideas. |
57 | | -* We have biweekly telecons which are announced on the email list. |
58 | | - |
59 | | -## Contributing code or documentation to PlasmaPy |
60 | | - |
61 | | -If you see something you'd like to work on amongst our |
62 | | -[issues](https://github.com/PlasmaPy/PlasmaPy/issues), or if you've got |
63 | | -a great idea for something to include in the package, start hacking away on |
64 | | -that! However, please announce your intent first in the relevant issue (or make |
65 | | -one if necessary) to make sure there is no work duplication. |
66 | | - |
67 | | -You can find most of what you should know in the [Contributing Guide](http://docs.plasmapy.org/en/latest/development/index.html). |
68 | | - |
69 | | -Please note that PlasmaPy has a [Code of Conduct](/conduct). |
70 | | - |
71 | | -Issues marked by the community as *help wanted* mean just that - either they're |
72 | | -good contributions for outsiders or there's an issue in the ongoing work that |
73 | | -requires a second opinion. Please consider these first! |
| 6 | +Thank you for your interest in contributing to PlasmaPy! To learn more, |
| 7 | +please check out the [Contributor Guide] in PlasmaPy's online documentation. |
| 8 | +This guide describes: |
| 9 | + |
| 10 | +- The [many ways to contribute] |
| 11 | +- [Getting ready to contribute] |
| 12 | +- The [code contribution workflow] |
| 13 | +- Best practices and common conventions for [writing code] |
| 14 | +- Creating and running [software tests] |
| 15 | +- Writing and building [documentation] |
| 16 | + |
| 17 | +If you would like to learn more, we encourage you to stop by one of |
| 18 | +our [community meetings](/meetings/weekly). |
| 19 | + |
| 20 | +The PlasmaPy community abides by the Contributor Covenant [Code of Conduct]. |
| 21 | + |
| 22 | +[code contribution workflow]: https://docs.plasmapy.org/en/latest/contributing/workflow.html |
| 23 | +[code of conduct]: https://docs.plasmapy.org/en/latest/CODE_OF_CONDUCT.html |
| 24 | +[contributor guide]: https://docs.plasmapy.org/en/latest/contributing/index.html |
| 25 | +[documentation]: https://docs.plasmapy.org/en/latest/contributing/doc_guide.html |
| 26 | +[getting ready to contribute]: https://docs.plasmapy.org/en/latest/contributing/getting_ready.html |
| 27 | +[many ways to contribute]: https://docs.plasmapy.org/en/latest/contributing/many_ways.html |
| 28 | +[software tests]: https://docs.plasmapy.org/en/latest/contributing/testing_guide.html |
| 29 | +[writing code]: https://docs.plasmapy.org/en/latest/contributing/coding_guide.html |
0 commit comments