Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You will have a local repo with two remotes: “origin” will point to your fork in your account, and “upstream” will point to the repo in the openedx org. The normal flow will be:

  1. Pull from upstream the upstream’s master branch into your fork’s master branch to get the latest code.

  2. Make a feature branch in your repo from your repo’s master branch. Don’t work directly

  3. Make your changes, and commit them.

  4. Push your branch to your fork (origin).

  5. Make a pull request against upstream.

  6. Once the review is complete, the owning team will approve and merge the pull request.

...

  • Visit the repo on GitHub.

  • In the upper-right corner is a Fork button. Click it.:

  • Image Added

    On the next screen, you will be asked where to fork it, called the Owner. Choose your own personal account (the default choice).:

    • Image Added

      edx will be listed in the drop-down, with “insufficient permission”

    • DO NOT FORK INTO edx EVEN IF YOU CAN. Use your personal account.

...

How you get the fork locally depends on whether you already have a local repo copy that you want to keep. If you have a local copy but don’t need it, you can delete the repo directory and use “I don’t have a local copy.”

A. I don’t have a local copy

  1. Clone the repo locally: git clone https://github.com/USER/REPO.git

  2. Add a new remote for upstream: git remote add upstream https://github.com/openedx/REPO.git

B. I have a local copy I want to keep

  1. Rename the existing remote:

    1. Use git remote -v to check that the openedx repo is named “origin”

    2. Rename the remote to “upstream”: git remote rename origin upstream.

  2. Add a new remote for your fork: git remote add origin https://github.com/USER/REPO.git

B. I don’t have a local copy

  1. Clone the repo locally: git clone https://github.com/USER/REPO.gitAdd a new remote for upstream: git remote add upstream https://github.com/openedx/REPO.git

Keeping your fork up to date

You now have two remote repos (your fork and the openedx core repo) that you might need to get changes from.

...