Permalink
Fetching contributors…
Cannot retrieve contributors at this time
56 lines (46 sloc) 3.02 KB

How to contribute

We welcome contributions from external contributors, and this document describes how to merge code changes into Psi4. As of February 2016, the procedure for contributing code is exactly the same for the core development team and for external contributors.

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Getting Started

  • Make sure you have a GitHub account.
  • Fork the psi4/psi4 repository on GitHub.
  • On your local machine, clone your fork of the Psi4 repository.
  • More detailed instructions for interacting with your Psi4 fork can be found here. and here.

Making Changes

  • Add some really awesome code to your local fork. It's usually a good idea to make changes on a branch with the branch name relating to the feature you are going to add.
  • When you are ready for others to examine and comment on your new feature, navigate to your fork of Psi4 on GitHub and open a pull request (PR). Note that after you launch a PR from one of your fork's branches, all subsequent commits to that branch will be added to the open pull request automatically. Each commit added to the PR will be validated for mergability, compilation and test suite compliance; the results of these tests will be visible on the PR page.
  • If you're providing a new feature, you must add test cases and documentation.
  • When the code is ready to go, make sure you run the full or relevant portion of the test suite on your local machine to check that nothing is broken.
  • When you're ready to be considered for merging, check the "Ready to go" box on the PR page to let the Psi4 team know that the changes are complete. The code will not be merged until this box is checked, the continuous integration (Travis for Linux and Distelli for Mac) returns checkmarks, and multiple core developers give "Approved" reviews.

Additional Resources