Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
# Open Eclipse
# Install egit (Eclipse: ''Help'' → ''Marketplace'' → Search for ''egit'' '''or''' get it from http://www.eclipse.org/egit/)
To clone the project from within Eclipse, you may need to install EGit first (Eclipse: ''Help'' → ''Marketplace'' → Search for ''egit'' '''or''' get it from http://www.eclipse.org/egit/).
EGit The Eclipse git plugin uses the [http://www.jcraft.com/jsch JSch] library , which is, however, had [https://bugs.eclipse.org/bugs/show_bug.cgi?id=326526 reported] to have problems with RSA SSH keys ] in linux Linux and possibly other platforms. A solution would be to use If the problem persists, the variable GIT_SSH and assign it a path to the native SSH executablecan be assigned to the {{Cpde|GIT_SSH}} variable. According to [http://egit.eclipse.org/r/#change,2037 this] change in EGit, the plugin will try to use a native SSH implementation instead of JSch (this, however, may not always work either :( ).
==Need help using git?== ===Installing=== For information on how to install git on various platforms please refer to: * [http://help.github.com/git-installation-redirect/ GitHub: git Installation Guide] ===Documentation===
no edit summary
==Using Git to contribute to BaseX ==
Our team uses git and [https://github.com GitHub] to manage the source code.All team members have read+/write access to the repository, and externalcontributors are welcome to fork the project.
Git makes it easy to retain a full copy of the repository for yourself.To get started and running, simply ''fork'' BaseX:
# Head over to https://github.com and create an account
# Fork https://github.com/BaseXdb/basex, so you have a version on your own
# The forked project can then be cloned on your local machine, and changes can be pushed back to your remote repository
==Using Git & Eclipse==
<table cellspacing='0' cellpadding='0' width='100%'>
===Clone===
* In the '''Package Explorer''' to the left , use right-click and choose '''Import...'''* Select "'''Projects from Git'''" and click '''Next >'''* Click "Choose the '''Clone...'''" option to create a local copy of the remote repository. This copy will include the full project history* 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 https URI and authenticate yourself with your GitHub credentials. The read-only URI of the repository is {{Code|https://github.com/BaseXdb/basex.git}}.
* Select the master branch (or arbitrary branches you like)
* Now choose a location where the local repository is stored: Create <workspace>'''/repos/BaseX''' and click "'''Finish'''".
===EGit & SSH===
==Using Git on Command-Line==
# Choose a directory where the project will be created and make it your working directory (e. g. /home/user/myprojects)
===Clone Your Personal Repository===
<pre class="brush:shell">
</pre>
===Pushing Local Changes to Remote Repository===
<pre class="brush:shell">
</pre>
===Add BaseXdb Upstream Repository===
The upstream repository is the one from which the BaseX releases are made and the one from which the personal repository was forked.
</td></tr></table>
===Developing a new feature or bug fix using git===
It is always a good idea to create a new branch for a new feature or a big fix you are working on. So first, let's make sure you have the most up-to-date source code. We assume, that you added BaseX as upstream repository as described above and you are currently in the ''master'' branch:
<pre class="brush:shell">
$ git push origin new-featuCounting featureCounting objects: 318, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (107/107), done.
Total 154 (delta 93), reused 81 (delta 26)
To git@github.com:$username/basex.git
* [new branch] new-feature -> new-featurerefeature
</pre>
'''Please review them carefully. Also, please give a meaningful comment so we can quickly determine what your changes are doing.''' After clicking the "Create Pull request" button you are done and we will review your changes and either merge the pull request or get back to you.
==Links==
* [http://help.github.com/ Comprehensive Getting Starting Guide on GitHub]
* [http://book.git-scm.com/index.html The git book]
* [http://gitcasts.com/ Gitcasts.com – Video Guides]
