Overview of Development Process

Workflow

MPQC is developed collaboratively using a simple workflow based on pull requests. Since MPQC is hosted on GitHub, we by default assume everyone will use the GitHub-provided mechanisms for working with pull requests. For more info see GitHub Help.

There are 2 models that can be used:

• Members of the Valeev Group are encouraged to use the shared repository model, i.e. create a feature branch (and create a pull request immediately), add/modify code, mark the pull request "ready to merge" when done, and respond to feedback (if any) before merging.
• Others can use the pull-and-fork model.

Recommended practices

• When you start working on a feature, it is recommended to immediately create a pull request. There are several reasons to do this.
  1. This will advertise your work to the rest of the team and avoid duplicate effort by keeping everyone abreast of what's in the pipeline.
  2. Others will be able to contribute to your work by pushing to your feature branch.
  3. This will enable Continuous Integration tests to be done on your feature branch.
• When you create a pull request, it is recommended to use the following template for the message:

<!--- Check this when ready to review; also feel free to add reviewers explicitly --->
- [ ] Ready for review

<!--- Add a (possibly detailed) description of this PR --->

Check the "Ready to review" checkbox when ready for the review process to start.