Skip to content

Commit

Permalink
replace devel with upstream everywhere
Browse files Browse the repository at this point in the history
  • Loading branch information
alinelena committed Aug 8, 2024
1 parent b7c8f2c commit 3d0b503
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ you can follow this routine,
$ git remote add upstream [email protected]:stfc/janus-core.git
# get the changes to upstream since you started working on your issue
$ git fetch upstream
# merge these changes into your branch (assuming you want to merge into the main branch on devel)
# merge these changes into your branch (assuming you want to merge into the main branch on upstream)
$ git merge upstream/main
# resolve any conflicts
# push to your fork
Expand All @@ -167,8 +167,8 @@ the differences between merge and rebase
# add upstream as a remote if you have not already
$ git remote add upstream [email protected]:stfc/janus-core.git
# get the changes to upstream since you started working on your issue
$ git fetch devel
# merge these changes into your branch (assuming you want to merge into the main branch on devel)
$ git fetch upstream
# merge these changes into your branch (assuming you want to merge into the main branch on upstream)
$ git rebase -i upstream/main
# resolve any conflicts
# push to your fork
Expand All @@ -180,9 +180,10 @@ $ git push

#### Keeping your fork in sync with project

By adding two remotes, one for *devel* and one for your *fork* it is
possible to keep your *fork* in sync with *devel*. This will greatly
simplify merge requests.
By adding two remotes, one for *upstream* and one for your *fork* it is
possible to keep your *fork* in sync with *upstream*. This will greatly
simplify merge requests. Github also offers a sync functionality in their
web ui that achieves the same.

``` sh
# clone your fork
Expand All @@ -199,11 +200,11 @@ the origin and project fetch and push links
$ git remote -v
origin [email protected]:username/janus-core.git (fetch)
origin [email protected]:username/janus-core.git (push)
devel [email protected]:stfc/janus-core.git (fetch)
devel [email protected]:stfc/janus-core.git (push)
upstream [email protected]:stfc/janus-core.git (fetch)
upstream [email protected]:stfc/janus-core.git (push)
```

When you need to sync your *fork* with *devel*, do the following,
When you need to sync your *fork* with *upstream*, do the following,

``` sh
# get the latest commits from upstream
Expand All @@ -223,7 +224,7 @@ available projects.

When working on an issue you may use multiple commits. When you are
ready to create a merge request, you should squash your changes into one
commit in order to keep *devel* clean. This is most easily achieved with
commit in order to keep *upstream* clean. This is most easily achieved with
an interactive rebase.

Assuming you have made five commits,
Expand Down

0 comments on commit 3d0b503

Please sign in to comment.