githowto

Git + Pyjamas (get/update/test/hack/contrib/devel)

This article will implement workflows for the following use cases:

;Consume Pyjamas :Get :Update :Test ;Produce Pyjamas :Hack :Contribute :Develop

The article assumes some prior exposure to git and it's concepts. If you have never used git, and/or dont know what/how to get it, check out the following:

• Official Site
  http://git-scm.com
• Everyday Git
  http://www.kernel.org/pub/software/scm/git/docs/everyday.html
• ProGit Book
  http://progit.org/book

Instructions will adhere to the following format:

[<num>     ]# <general command>
[<num><alt>]# <alternate command>
  <num> .     <general explanation>
    <alt> )   <alternate explanation>

Commands lacking an alt letter are general and apply to all methods; else the command is specific to an alternative workflow. Follow the same alt letter (or none) throughout the document. The author recommends, and uses, alt b.

Get Pyjamas

[1  ]# git clone https://github.com/pyjs/pyjs.git
[2  ]# cd pyjamas
[3b ]# git checkout --track -b foo origin/master
[4b ]# git branch -d master

1. Clone the codebase into a folder called ##pyjamas##
2. Move to the the working directory
3. ...
   b) Create a new branch called foo, tracking ##origin/master##, and check it out. ##--track## allows ##git pull## to be used without arguments (by default, ##--track## is implied for remote branches; included for completeness)
4. ...
   b) Remove the default ##local/master## branch. This branch adds unnecessary steps to your workflow, and exists only by convention; best to learn how to use git explicitly, learning both why you must execute command X, and how it works.

Update Pyjamas

[1  ]# cd pyjamas
[2a ]# git pull
[2b ]# git remote update origin
[3b ]# git merge origin/master

1. Move to the the working directory
2. Fetch and update all remote branches (refs/remotes/origin) for ##origin##, and ...
   a) ... automatically merge into ##local/master##, or the current branch (if current branch is tracking another branch)
   b) ... do nothing further
3. ...
   b) Merge updated ##origin/master## into the current branch ##foo##

Test Pyjamas

TODO

Hack on Pyjamas

TODO

Contribute to Pyjamas

[1] # cd pyjamas
      (most likely your pyjamas installation is in ~/pyjamas/pyjamas)
[2] # git diff > patch.diff

Develop Pyjamas

TODO