Project

General

Profile

Git-maus » History » Version 11

Dobbs, Adam, 24 February 2017 17:48

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