Contribution Workflow

This page describes the steps for making a contribution to MPCPy.

1. Open a new issue and assign it to someone who can address it (which may be you).
2. Make (checkout) a new branch from the master branch. Name this new branch according to the following convention: issue#_briefDescription.
3. Implement changes on the new branch, documenting on the issue tracker as necessary.
4. If adding a new feature, implement a unit test(s) for your changes. Otherwise, update the unit test(s) associated with your changes accordingly.
5. Merge the latest version from the master to your branch and run all unit tests to verify changes have not broken stable code.
6. Make a pull request from the new branch to the master, assign the issue to @dhblum for review and for merging to the master branch.
7. If the revisions are reviewed and correct, merge the pull requests to the master, delete the branch and close the ticket. Otherwise, the issue tracker will be used to communicate necessary changes and iterate through steps 3. to 7.