Contribute

Provide Feedback

We could always use more voices and opinions in the discussions about sunpy and its development from both users and developers. You may want to suggest a new feature or tell us about how something is not working in the manner you would expect it to. There are a number of ways to make your voice heard and we would love to hear from you.

We strongly recommend that your first port of call would be to our lovely matrix channel. Here you can get in easily get in touch with developers or users for questions or support. This is the most lively part of the community!

If you prefer email:

• The general mailing list is a great place to start. Here we answer questions about sunpy or send out major announcements.

• If you have technical issue about the code or want advice on how to help sunpy, the developer mailing list is another good place. This is where you can find the nitty gritty nuts and bolts discussions about the SunPy codebase.

Please note that these do not get a lot of traffic, so the matrix channel or GitHub might be better places to start.

Report Bugs

If you run into unexpected behavior or run into a bug we urge you to please report it. All bugs are kept track of on our issue tracker. You can add a bug report there or you can report it on matrix channel or an email to the developer mailing list. Ideally, we would like a short code example so we can reproduce the bug on our own machines.

Provide Code

If you are interested in contributing fixes, code or documentation to sunpy please have a read of our newcomers guide. This is the easiest entry point into our more in-depth developer guide.

sunpy uses a distributed version control system called git and the code is hosted on GitHub. To get started, create an account on github and fork sunpy then submit your changes via a pull request. If you are unfamiliar with this style of development, Astropy provide a sample workflow but you can also find lots of tutorials online. You can browse our issue list or our feature list to find something that you can tackle. Please leave a comment on the issue on GitHub and stop by the matrix channel to let people know what you are planning to work on.