Project

General

Profile

Edit History

Git-maus » History » Version 17

Dobbs, Adam, 24 February 2017 18:25

1 1 Dobbs, Adam 
h1. Git-maus
2 





    3
    5
    Dobbs, Adam
    
Besides Launchpad and bazaar MAUS has beta level support for git and"github":https://github.com/mice-software/maus. At the moment code updates for the trunk cannot be accepted from github however, only via Launchpad and bazaar.





    4
    1
    Dobbs, Adam
    





    5
    
    
    
h2. Development





    6
    
    
    





    7
    2
    Dobbs, Adam
    
h3. Set up a development branch





    8
    
    
    





    9
    12
    Dobbs, Adam
    
* Set up an account on "github":https://github.com/ and "add an ssh key":https://help.github.com/articles/connecting-to-github-with-ssh/ to your account





    10
    
    
    
* Clone the MAUS repository as described at [[Install#Git-and-GitHub-beta-support| Obtaining MAUS via Git]]





    11
    2
    Dobbs, Adam
    
* Fork the MAUS repository on github





    12
    
    
    
** Go to MAUS github page and login into github





    13
    
    
    
** Click "Fork" in the top right of the screen, selecting the option to fork to your own account





    14
    17
    Dobbs, Adam
    
!http://micewww.pp.rl.ac.uk/attachments/8359/GitHubForkScaled.png!





    15
    2
    Dobbs, Adam
    
* Add your fork as a new remote in your local MAUS git repository





    16
    
    
    
** Copy the address of your new fork from github (something like @git@github.com:jbloggs/maus.git@, where jbloggs is your github username)





    17
    
    
    
** Return to the terminal and navigate to the MAUS git repository created earlier





    18
    
    
    
** Add your new forked repository using:





    19
    
    
    
<pre>





    20
    
    
    
git remote add my-fork git@github.com:jbloggs/maus.git





    21
    
    
    
</pre>





    22
    
    
    
where jbloggs is your github username.





    23
    
    
    
* Fork the merge branch locally:





    24
    
    
    
<pre>





    25
    
    
    
git checkout merge





    26
    
    
    
git checkout -b my-feature-branch





    27
    
    
    
</pre>





    28
    
    
    
* Push your local fork of the merge branch to your remote repository:





    29
    
    
    
<pre>





    30
    
    
    
git push my-fork my-feature-branch





    31
    
    
    
</pre>





    32
    
    
    
* Do some coding





    33
    
    
    
* When ready add the files you have modified or created ready for committing:





    34
    
    
    
<pre>





    35
    
    
    
git add <files>





    36
    
    
    
</pre>





    37
    
    
    
* Commit your changes:





    38
    
    
    
<pre>





    39
    
    
    
git commit -m 'Some informative message about the changes'





    40
    1
    Dobbs, Adam
    
</pre>





    41
    3
    Dobbs, Adam
    
* Push the changes to your remote repository:





    42
    
    
    
<pre>





    43
    
    
    
git push my-fork my-feature-branch





    44
    
    
    
</pre>





    45
    
    
    





    46
    
    
    
h3. Propose your branch for merging





    47
    
    
    





    48
    
    
    
* Run Jenkins test server job on your development branch (email the head of MAUS for help with setting up a test branch)





    49
    
    
    
* When Jenkins has passed, return to your repository page on github and select @my-feature-branch@ from the drop-down menu on the left





    50
    
    
    
* Click the "Pull request" button to propose merging into the trunk





    51
    
    
    
* Make sure your branch is comfortable for merging - if not, edit some more until it is, commit and push, then try again