Skip to content

Latest commit

 

History

History
235 lines (153 loc) · 7.8 KB

CONTRIBUTING.md

File metadata and controls

235 lines (153 loc) · 7.8 KB
Raw

git

There are several ways you could have obtained the dysh source code:

  1. You cloned from the upstream : https://github.com/GreenbankObservatory/dysh. This is fine if you just want to use it, but not ideal if you make modifications and want to share them back to the upstream via a pull request (PR). You can however "repair" your local repo, discussed below, and still submit a PR.

  2. You forked dysh from the upstream, and cloned it locally from the repo in your own github account. This is the ideal method, but you will still need to set the upstream manually if you used github.com. See also the gh command below for an even easier way.

  3. Sadly on github.com you will also find a zip copy of the repo that does actually work fine, except it's a frozen snapshot and cannot be efficiently used to collaborate. However, if you cannot install git, this is probably the only way to bootstrap yourself. For example https://github.com/GreenbankObservatory/dysh/archive/refs/heads/main.zip, which will create a directory dysh-main. Other branches are available through similar zip file construct. For releases, we suggest to use a tagged release, for example https://github.com/GreenBankObservatory/dysh/archive/refs/tags/0.1.0.zip which would create a directory dysh-0.1.0.

  4. You used "pip install". In this way the source is likely hidden within your python/site-packages tree, and this is not a good habit to hack the code (but not impossible if you have write permission there).

Familiarize yourself with the concept of a pull request on github. There are some links at the bottom of this document.

gh: github CLI

You can safely skip this section if you prefer to work via github.com, though the gh command described here is by far the fastest and easiest way to work with the github ecosystem. You just have to insYou did tall yet another tool for this.

If you can use conda, installation can be done as follows:

  conda install gh --channel conda-forge

but see also manual installing instructions, after this you need to authenticate once via your github account:

  gh auth login

after which you could create your own fork, clone locally, and set the upstream all in just one step:

  gh repo fork https://github.com/GreenbankObservatory/dysh

If all is well, the following commands should show the correct origin and upstream:

  git remote -v

  origin git@github.com:YOURNAME/dysh.git
  upstream git@github.com:GreenbankObservatory/dysh.git

for both the (fetch) and (push). None of these should be blank! You are now ready for working in your own branches and issue a pull request (PR).

2. Cloning your personal fork

This section can be skipped if you use the gh repo fork method described before this.

If you have cloned your own fork on github.com, you should now clone it

  git clone https://github.com/YOURNAME/dysh

you only need to set the upstream:

  git remote add upstream https://github.com/GreenbankObservatory/dysh

and you are ready for creating a PR (from a branch of course).

1. Cloning the official upstream

If you happened to have cloned the official upstream

  git clone https://github.com/GreenbankObservatory/dysh

then things are a bit more complicated, because you should have cloned your fork. However, the following commands will fix this (assuming you also went to github.com and made that fork):

  git remote rename origin upstream
  git remote add    origin https://github.com/YOURNAME/dysh

Again, the gh command now gives a single line shortcut to all this:

  gh repo fork https://github.com/GreenbankObservatory/dysh

Keeping your clone in sync

You should regularly make sure your local master branch is in sync with the upstream master branch. This allows you to work in local branches, and be up to date by branching off the tip of this upstream master branch. Here's a recipe for that in your local clone:

  git checkout master
  git fetch upstream
  git merge upstream/master
  git status
  git push

Working in a branch

Assuming your own master is in sync with the upstream master, here is a typical example to work in a branch, using a branchname b1

  git branch b1
  git checkout b1

  ## edit/add your files; test them; commit them, e.g.
  git commit -m "my comment"  existing_file
  git add new_file
  git commit -m "my command"  new_file

  git push -u origin b1

Now you can issue a pull request on this branch b1.

If you have become a fan on the gh pr method, here's the recipe for this:

  git checkout -b b1
    <<edit, test, commit>>
  gh pr create

once the branch has been merged, you don't need it locally anymore, so delete it

  git branch -d b1
  git push original --delete b1

Common work in a branch

Lets say there is a new development idea, lets call it "table2", and others will share the development in this "table2" branch, but until the development is done, this is not merged to the master yet.

  1. DYSH (upstream) itself will start making this new development branch:

    git checkout -b table2
...
git push --set-upstream origin table2

  2. others will do then branch off this new branch (user astroumd is used as example here):

    gh repo fork https://github.com/GreenbankObservatory/dysh dysh
cd dysh
git remote add upstream  https://github.com/GreenbankObservatory/dysh
git fetch upstream
git checkout -b myTable3
git merge upstream/table2
...
git push --set-upstream origin myTable3

    on github.com/astroumd/dysh you can then do a pull request from astroumd::myTable3 to teuben:table2. An alternative (next item) is that the upstream person would pull in myTable3 and tests locally

  3. DYSH, optionally, creates an alias site "astroumd" and merge from their myTable3 branch to check out the code

    git checkout table2
git remote add  astroumd  https://github.com/astroumd/dysh
git pull astroumd
git merge [--no-ff] astroumd/myTable3
.... (resolve conflicts)
git push

  4. after this, all collaborators will need to merge these back:

    git checkout myTable3
git fetch upstream
git merge upstream/table2

Memorable git options

  1. Show all files modified in a branch AAA

    git diff master...AAA --name-status --diff-filter=M

  2. When was a branch created

    git show --summary git merge-base AAA master gitk --all --select-commit=git merge-base foo master

  3. To see which files belonged in a commit, find the sha (e.g. via "git log" or "git log file" if you know the file that belonged to it), then

    git diff-tree --no-commit-id --name-only -r SHA

  4. Difference between two SHA's

    git diff <commit-id> <commit-id>

PR with github CLI

Recapping working with "github CLI" (gh)

Step 1 from the submitter of the PR:

   gh repo fork https://github.com/GreenbankObservatory/dysh
   cd dysh
   git checkout -b teuben1
   $EDITOR index.md
   gh pr create

Once the branch has been merged by the upstream, there is no need to keep it. It can be removed as follows:

   git branch -d teuben1
   git push original --delete teuben1

Step 2 by the receiver of the PR:

References

Some references on git workflows: