Difference between revisions of "Git"

From BaseX Documentation
Jump to navigation Jump to search
Line 21: Line 21:
  
 
<div class="subcolumns">
 
<div class="subcolumns">
 +
===Setup ===
 
<div class="c50l">
 
<div class="c50l">
 +
 
[[File:Git01.png|border|300px|left]] In the '''Package Explorer''' to the left use right-click and choose Import...
 
[[File:Git01.png|border|300px|left]] In the '''Package Explorer''' to the left use right-click and choose Import...
 
</div>
 
</div>
Line 29: Line 31:
 
</div>
 
</div>
 
<div class="subcolumns">
 
<div class="subcolumns">
 +
===Clone ===
 +
 
<div class="c50l">
 
<div class="c50l">
 
[[File:Git03.png|border|300px|left]] Click "'''Clone...'''" to create a local copy of the remote repository. This copy will include the full project history
 
[[File:Git03.png|border|300px|left]] Click "'''Clone...'''" to create a local copy of the remote repository. This copy will include the full project history
Line 43: Line 47:
 
</div>
 
</div>
 
<div class="c50r">
 
<div class="c50r">
[[File:Git06.png|border|300px|left]] Now choose a location where the local repository is stored: Pick &lt;workspace&gt;/repos/BaseX
+
[[File:Git06.png|border|300px|left]] Now choose a location where the local repository is stored: Create &lt;workspace&gt;'''/repos/BaseX'''
and click "'''Finish'''"
+
and click "'''Finish'''".
 
 
 
</div>
 
</div>
Line 50: Line 54:
  
 
<div class="subcolumns">
 
<div class="subcolumns">
 +
===Create the project ===
 
<div class="c50l">
 
<div class="c50l">
 
[[File:Git07.png|border|300px|left]] Select our newly cloned repository and click Next
 
[[File:Git07.png|border|300px|left]] Select our newly cloned repository and click Next
Line 68: Line 73:
 
</div>
 
</div>
 
</div>
 
</div>
 +
 
==Need help using git?==
 
==Need help using git?==
 
===Installing===
 
===Installing===

Revision as of 19:56, 17 February 2011

Using Git to contribute to BaseX

The team uses git and GitHub to manage the source code.

All team members have read+write access to the repository, external contributors are invited to fork the project.

Git makes it easy to retain a full copy of the repository for yourself, to get up and running simply fork BaseX. If forking sounds unfamiliar to you I suggest you go read the GIT#Need_help_using_git.3F Manual.

You can then build BaseX with Maven.

Using Git & Eclipse

  1. (Optional) Head over to BaseX at GitHub and create an account
  2. Fork BaseX so you have a version on your own
  3. Make yourself familiar with git, there are several tutorials around the web
  4. Install egit (Eclipse: Help > Marketplace > Search for egit or get it from here)
  5. Open Eclipse


Setup

Git01.png
In the Package Explorer to the left use right-click and choose Import...
Git02.png
Select "Projects from Git" and click Next >

Clone

Git03.png
Click "Clone..." to create a local copy of the remote repository. This copy will include the full project history
Git04.png
Copy & Paste the github URI in the Location field. If you want to use SSH make sure you provided GitHub with your public key to allow write-access. If in doubt use the HTTPS URI and authenticate yourself with your GitHub credentials.
Git05.png
Select the master branch (or arbitrary branches you like)
Git06.png
Now choose a location where the local repository is stored: Create <workspace>/repos/BaseX

and click "Finish".

Create the project

Git07.png
Select our newly cloned repository and click Next
Git08.png
Select "Import Existing Projects" and depending on your Eclipse version enable automatic sharing. More recent versions will not offer this feature as sharing is enabled by default.

Click next to select the Project to import

Git09.png
Check "basex" to checkout and click finish
Git10.png
You are now ready to contribute.

Need help using git?

Installing

For more information please refer to: GitHub: git Installation Guide

Documentation