-
Notifications
You must be signed in to change notification settings - Fork 340
Closed
Description
Currently, the Contributing Guide only discusses forking and submitting a PR. However, during the development process, changes can occur in the upstream/parent repository and so, before submitting a PR, it is important to:
- Sync your fork with the upstream/parent repo (see image below for a button to sync with upstream)
- Pull your changes into your cloned fork
- Merge the upstream changes in your local fork with your development branch (i.e., the branch where you are developing the PR)
- Run the unit tests
Here is some relevant documentation on the above. Note that STUMPY uses main and not master:
https://docs.github.com/en/github/collaborating-with-pull-requests/working-with-forks/syncing-a-fork
This should be added as a "Bonus Section" at the very end of the Contributing Guide
