Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 2.44 KB

File metadata and controls

53 lines (41 loc) · 2.44 KB

Fixing an issue for MDAnalysis

With over 400 issues on the core library and User Guide, we are always looking for new and old contributors to help enhance and maintain MDAnalysis.

Getting started

In order to contribute to MDAnalysis, you will need to set up a development environment, make a fork of the MDAnalysis codebase and then contribute the code back using a Pull Request.

Our User Guide has a handy contributors guide which you can follow for all the information you need to achieve this. Feel free to ask any members of the team for help if you encounter any issues getting started.

Choose an issue

We have plenty of issues available for you to work on in our Issue Trackers for the core library or User Guide. For first time contributors, we encourage you to look at our list of easy bugs to fix. Have a chat with us, to see which one would suit you best! When you find something, please let us know in the issue that you are working on it so that other attendees do not work on the same thing!

Our recommended pick is the doctest MEGA-issue which involves fixing our documentation so that code examples are self-contained and should run on their own if you try them out! Here multiple attendees can work on this issue, just let us know which files you are planning to work on.

Make a Pull Request!

Once you have made the suitable code change to fix the issue, open a Pull Request and we will review your code change and work with you towards getting your contribution merged.

This can sometimes be a slow process, especially when the code change is large and there are many Pull Requests. If you wish to help, you are welcome to review other people's Pull Requests by leaving comments on their code with any changes you would suggest!