Pull Requests#

We welcome contributions to SimPEG in the form of pull requests (PR).

Stages of a pull request#

When first creating a pull request (PR), try to make your suggested changes as tightly scoped as possible (try to solve one problem at a time). The fewer changes you make, the faster your branch will be merged!

If your pull request is not ready for final review, but you still want feedback on your current coding process please mark it as a draft pull request. Once you feel the pull request is ready for final review, you can convert the draft PR to an open PR by selecting the Ready for review button at the bottom of the page.

Once a pull request is in open status and you are ready for review, please ping the simpeg developers in a github comment @simpeg/simpeg-developers to request a review. At minimum for a PR to be eligible to merge, we look for

  • 100% (or as close as possible) difference testing. Meaning any new code is completely tested.

  • All tests are passing.

  • All reviewer comments (if any) have been addressed.

  • A developer approves the PR.

After all these steps are satisfied, a @simpeg/simpeg-admin will merge your pull request into the main branch (feel free to ping one of us on Github).

This being said, all SimPEG developers and admins are essentially volunteers providing their time for the benefit of the community. This does mean that it might take some time for us to get your PR.