DistributedDevelopment

This page outlines how newly contributed code is merged into the main repository.

Note: Please also check the repository structure and the development workflow for background information.

git allows us to use a distributed development model.

1. Anyone can simply clone the repository and work on the clone. (If you have an account on GitHub then just fork the MDAnalysis/mdanalysis repository.)
2. Once the code in the clone is ready to be integrated in the main development line, send a "pull" request. On GitHub, this means to create a pull request. If you have a publicly accessible git repository elsewhere, send a pull request to the mdnalysis-devel list so that one of the core developers can review the changes and integrate them.

Procedure

The most convenient approach is to use pull requests on GitHub:

1. Submit the pull request.
2. Any pull request is automatically run through the unit tests (via travis-ci). If it does not pass, fix and amend you pull request.
3. Developers will ask questions and comment in the pull request. Participate in the discussion.
4. When everything looks good, a developer will merge your pull request into the development version.