Changes

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 external contributors 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%'><tr><td valign='top'>[[File:Git01.png|border|300px|left]][[File:Git02.png|border|300px|left]][[File:Git03.png|border|300px|left]][[File:Git04.png|border|300px|left]][[File:Git05.png|border|300px|left]][[File:Git06.png|border|300px|left]][[File:Git07.png|border|300px|left]][[File:Git08.png|border|300px|left]][[File:Git09.png|border|300px|left]][[File:Git10.png|border|300px|left]] </td><td valign='top'> ===Clone=== * In the '''Package Explorer''' to the left, use right-click and choose '''Import...'''* Select '''Projects from Git''' and click '''Next &gt;'''* 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 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 &lt;workspace&gt;'''/repos/BaseX''' and click "'''Finish'''".  ===Create the project === * Select our newly cloned repository and click Next* 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* Check "basex" to checkout and click finish* You are now ready to contribute.  ===EGit & SSH=== The Eclipse git plugin uses the [http://www.jcraft.com/jsch JSch] library, which had [https://bugs.eclipse.org/bugs/show_bug.cgi?id=326526 problems with RSA SSH keys] in Linux and possibly other platforms. If the problem persists, the path to the native SSH executable can 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. ==Using Git on Command-Line== '''Note''': this is not intended to be a complete git reference; it's purpose is to quickly introduce BaseX developers to the most commonly used git commands in the context of the BaseX project. ===Preparation=== # Create a GitHub user account: [https://github.com/signup/free here] (your github user name will be referenced as $username)# Set up SSH access to GitHubas described [http://help.github.com/key-setup-redirect here]# Create a fork of one of the BaseXdb projects (it will be referenced as $project)# Choose a directory where the project will be created and make it your working directory (e. g. /home/user/myprojects) ===Clone Repository=== <pre class="brush:shell">$ git clone git@github.com:$username/$project.gitCloning into $project...Enter passphrase for key '/home/user/.ssh/id_rsa': ... $ ls -d -1 $PWD/*/home/user/myprojects/$project</pre>Note that git automatically creates a directory where the repository content will be checked out. ===List Remote Repositories=== <pre class="brush:shell">$ git remote -vorigin git@github.com:$username/$project.git (fetch)origin git@github.com:$username/$project.git (push)</pre>Currently, there is only one remote repository; it is automatically registered during the clone operation. Git remembers this repository as the default repository for push/pull operations. ===List Local Changes=== After some files have been changed locally, the changes can be seen as follows:<pre class="brush:shell">$ git diffdiff --git a/readme.txt b/readme.txtindex fabaeaa..cd09568 100644--- a/readme.txt+++ b/readme.txt@@ -49,6 +49,10 @@ ADDING CHECKSTYLE -------------------------------------------------------------- - Enter the URL: http://eclipse-cs.sourceforge.net/update - Follow the installation procedure and restart Eclipse +USING GIT ---------------------------------------------------------------------- Any kind of feedback is welcome; please check out the online documentation at</pre> ===Commit to Local Repository=== '''Note''': this commit operation does '''not''' commit into the remote repository! First, it is needed to select the modified files which should be committed:<pre class="brush:shell">$ git add readme.txt</pre> Then perform the actual commit:<pre class="brush:shell">$ git commit[master 0fde1fb] Added TODO in section "USING GIT" 1 files changed, 4 insertions(+), 0 deletions(-)</pre>Before executing the actual commit, git will open the default shell editor (determined using the $EDITOR variable, usually vi) to enter a message describing the commit changes. Alternative way is to commit all changed files, i. e. it is not needed to explicitly add the changed files:<pre class="brush:shell">$ git commit -a[master 0fde1fb] Added TODO in section "USING GIT" 1 files changed, 4 insertions(+), 0 deletions(-)</pre> ===Pushing Changes to manage Remote Repository=== <pre class="brush:shell">$ git pushEnter passphrase for key '/home/user/.ssh/id_rsa': Everything up-to-date</pre> ===Pulling Changes from Remote Repository=== <pre class="brush:shell">$ git pullEnter passphrase for key '/home/user/.ssh/id_rsa': Already up-to-date.</pre> ===Add Upstream Repository=== The upstream repository is the one from which the BaseX releases are made and the one from which the source codepersonal repository was forked. <pre class="brush:shell">$ git remote add upstream git@github.com:BaseXdb/$project.git $ git remote -vorigin git@github.com:$username/$project.git (fetch)origin git@github.com:$username/$project.git (push)upstream git@github.com:BaseXdb/$project.git (fetch)upstream git@github.com:BaseXdb/$project.git (push)</pre> ===Pulling Changes from Upstream to Local Repository===

All team members have read+write access to When some changes are made in the upstream repository, external contributors are invitedthey can be pulled to fork the project. local repository as follows:

Git makes it easy to retain a full copy of the repository <pre class="brush:shell">$ git pull upstream masterEnter passphrase for yourselfkey '/home/user/. To get started and running, simply fork BaseXssh/id_rsa': From github.com:BaseXdb/$projectIf forking sounds unfamiliar to you, we suggest * branch master -> FETCH_HEADAlready up-to look up some of the documentation listed at the end of this page-date.</pre>

You The changes can then build BaseX with [[Maven]]. Using Eclipse is optional.be pushed in the personal repository:<pre class="brush:shell">$ git push</pre>

# (Optional) Head over to [https://github.com/BaseXdb/BaseX BaseX at GitHub] and create an account# Fork BaseX so you have ===Developing a version on your own# Make yourself familiar with git (see the end of this page)# Install egit (Eclipse: Help > Marketplace > Search for ''egit'' '''new feature or''' get it from [http://www.eclipse.org/egit/ here])# Open Eclipsebug fix===

[[File:Git01.png|border|300px|left]] In the '''Package Explorer''' to the left use right-click and choose Import... </div> <div pre class="c50rbrush:shell"> [[File:Git02.png|border|300px|left]] Select "'''Projects from Git'''" and click Next &gt; </div>$ git pull upstream master</div><div class="subcolumns"pre>===Clone ===

<div class="c50l"> [[File:Git03.png|border|300px|left]] Click "'''Clone...'''" to Now, we create a local copy of new branch, based on the remote repository. This copy will include the full project history </div> <div class="c50r"> [[File:Git04.png|border|300px|left]] 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. </div></div>master branch

<div pre class="subcolumnsbrush:shell"> <div class="c50l">$ git checkout -b new-feature [[File:Git05.png|border|300px|left]] Select the master Switched to a new branch (or arbitrary branches you like) </div> <div class="c50r"> [[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'new-feature''". </div></divpre>

Your are now automatically switched to the ''new-feature'' branch. Now you can make all your changes in one or several commits. You can commit all changes using <div pre class="subcolumnsbrush:shell">===Create $ git commit -a</pre> Now, you want to push these changes to the project ===repository on GitHub. Remember, that up to now your changes just reside on your local drive, so now you want to push it to your remote fork of BaseX. Simply do:  <div pre class="c50lbrush:shell"> [[File$ git push origin new-featureCounting objects: 318, done.Delta compression using up to 4 threads.Compressing objects: 100% (107/107), done.Writing objects:Git07100% (154/154), 22.png96 KiB |border|300px|left0 bytes/s, done.Total 154 (delta 93), reused 81 (delta 26)To git@github.com:$username/basex.git * [new branch]] Select our newly cloned repository and click Next new-feature -> new-feature </divpre> <div class="c50r"> You can now use your web browser and go to your fork of BaseX. You will see the following message: [[File:Git08Git11.png|border|300px|left]] Select  You can now click the "'''Import Existing Projects'''Compare & pull request" and depending on your Eclipse version enable automatic sharingbutton. More recent versions will not offer this feature as sharing is enabled by default. Click next to select You can now review the Project changes you are going to import </div></div>push.

<div class="subcolumns"> <div class="c50l"> [[File:Git09'''Please review them carefully. Also, please give a meaningful comment so we can quickly determine what your changes are doing.png|border|300px|left]] Check ''' After clicking the "basexCreate Pull request" to checkout button you are done and we will review your changes and click finish </div> <div class="c50r"> [[File:Git10.png|border|300px|left]] You are now ready either merge the pull request or get back to contributeyou. </div></div>

==Need help using git?Links=====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]