Project

General

Profile

Git-maus » History » Version 21

Dobbs, Adam, 24 February 2017 18:29

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 19 Dobbs, Adam
** Go to "MAUS github page":https://github.com/mice-software/maus and login into github
13 2 Dobbs, Adam
** Click "Fork" in the top right of the screen, selecting the option to fork to your own account
14 18 Dobbs, Adam
15 21 Dobbs, Adam
16 20 Dobbs, Adam
    !http://micewww.pp.rl.ac.uk/attachments/8360/GitHubForkScaled.png!
17 21 Dobbs, Adam
18 18 Dobbs, Adam
19 2 Dobbs, Adam
* Add your fork as a new remote in your local MAUS git repository
20
** Copy the address of your new fork from github (something like @git@github.com:jbloggs/maus.git@, where jbloggs is your github username)
21
** Return to the terminal and navigate to the MAUS git repository created earlier
22
** Add your new forked repository using:
23
<pre>
24
git remote add my-fork git@github.com:jbloggs/maus.git
25
</pre>
26
where jbloggs is your github username.
27
* Fork the merge branch locally:
28
<pre>
29
git checkout merge
30
git checkout -b my-feature-branch
31
</pre>
32
* Push your local fork of the merge branch to your remote repository:
33
<pre>
34
git push my-fork my-feature-branch
35
</pre>
36
* Do some coding
37
* When ready add the files you have modified or created ready for committing:
38
<pre>
39
git add <files>
40
</pre>
41
* Commit your changes:
42
<pre>
43
git commit -m 'Some informative message about the changes'
44 1 Dobbs, Adam
</pre>
45 3 Dobbs, Adam
* Push the changes to your remote repository:
46
<pre>
47
git push my-fork my-feature-branch
48
</pre>
49
50
h3. Propose your branch for merging
51
52
* Run Jenkins test server job on your development branch (email the head of MAUS for help with setting up a test branch)
53
* When Jenkins has passed, return to your repository page on github and select @my-feature-branch@ from the drop-down menu on the left
54
* Click the "Pull request" button to propose merging into the trunk
55
* Make sure your branch is comfortable for merging - if not, edit some more until it is, commit and push, then try again