Skip to content

Update Contributing Guide to Sync Fork #414

@seanlaw

Description

@seanlaw

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:

  1. Sync your fork with the upstream/parent repo (see image below for a button to sync with upstream)
  2. Pull your changes into your cloned fork
  3. Merge the upstream changes in your local fork with your development branch (i.e., the branch where you are developing the PR)
  4. 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

E4M-4IYXoAwDUUA

This should be added as a "Bonus Section" at the very end of the Contributing Guide

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions