Git

From BaseX Documentation
Revision as of 19:43, 17 February 2011 by Michael (talk | contribs)
Jump to navigation Jump to search

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.

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


Git01.png
In the Package Explorer to the left use right-click and choose Import...
Git02.png
Select "Projects from Git" and click Next >
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: Pick <workspace>/repos/BaseX

and click "Finish"

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?