How to work with GitHub for ssn

From Spatial Data on the Web Working Group
Jump to: navigation, search

Recommended pattern for github workflow for W3C spec drafting (modified very slightly from Jeremy's original for bp deliverable):


  1. create a local copy of the W3C SDW repo: git clone https://github.com/w3c/sdw.git
  2. configure remotes on local - specify the W3C repo remote as `upstream`: git remote add upstream https://github.com/w3c/sdw.git
  3. Fetch the branches and their respective commits from the upstream repository: git fetch upstream
  4. because we're using GitHub Pages for publication, `gh-pages` is our main branch
  5. create a branch in your local repo which tracks gh-pages in upstream: git checkout -b {my-branch-name} upstream/gh-pages
  6. make the changes in your branch & commit - with commit message please!
  7. synchronise your changes with upstream: git push upstream {my-branch-name}
  8. within GitHub, create a Pull Request from {my-branch-name} into gh-pages ... at this point, you might assign the PR to someone else to check before merging
  9. EDITORS ONLY: within GitHub, Merge the changes into gh-pages ... then you will see your stuff @ http://w3c.github.io/sdw/ssn/
  10. bring all those changes back into your local repo: git fetch upstream
  11. rebase (don't 'pull' - because this creates another commit) changes on your branch: git rebase upstream/gh-pages

(you might also want to rebase upstream/{my-branch-name} too--this enables you to push subsequent local commits to your own remote branch when it has not yet been merged into the main branch and the main branch has been changed in the meantime. )

Alternatively - send your text to the Editors (Kerry, Danh, Krzysztof, Armin) via the WG email list.