Changes

The 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 GitHub''' 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 {{Code|GIT_SSH}} variable. According to [http://egit.eclipse.org/r/#change,2037 this] change in EGit, the plugin will try to manage 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 source codeBaseX project. ===Preparation===

All team members have read+write # 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 GitHub as described [http://help.github.com/key-setup-redirect here]# Create a fork of one of the repository, external contributors are invitedBaseXdb projects (it will be referenced as $project)to fork # Choose a directory where the projectwill be created and make it your working directory (e. g. /home/user/myprojects)

You can then build BaseX with [[Maven]]<syntaxhighlight lang="shell">$ git clone git@github.com:$username/$project.gitCloning into $project...Enter passphrase for key '/home/user/.ssh/id_rsa': ...

<div class="subcolumns">==List Local Changes=Setup === <div class="c50l">

[[FileAfter some files have been changed locally, the changes can be seen as follows:Git01<syntaxhighlight lang="shell">$ git diffdiff --git a/readme.png|border|300px|left]] In the '''Package Explorer''' to the left use right-click and choose Importtxt b/readme.txtindex fabaeaa..cd09568 100644--- a/readme.txt <+++ b/div>readme.txt <div class="c50r">@@ -49,6 +49,10 @@ ADDING CHECKSTYLE -------------------------------------------------------------- [[File - Enter the URL: http:Git02//eclipse-cs.sourceforge.png|border|300px|left]] Select "'''Projects from Git'''" net/update - Follow the installation procedure and click Next &gtrestart Eclipse +USING GIT ---------------------------------------------------------------------- Any kind of feedback is welcome; </div>please check out the online documentation at</divsyntaxhighlight><div class="subcolumns">===Clone ===

<div class="c50l"> [[File:Git03.png|border|300px|left]] Click "'''Clone...'''" ==Commit to create a local copy of the remote repository. This copy will include the full project history </div> <div classLocal Repository==="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>

<div class="subcolumns"> <div class="c50l"> [[File:Git05.png|border|300px|left]] Select the master 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/BaseXNote''' and click ": this commit operation does '''Finishnot'''". </div></div>commit into the remote repository!

First, it is needed to select the modified files which should be committed:<syntaxhighlight lang="shell">$ git add readme.txt</syntaxhighlight> Then perform the actual commit:<syntaxhighlight lang="shell">$ git commit[master 0fde1fb] Added TODO in section "USING GIT" 1 files changed, 4 insertions(+), 0 deletions(-)</syntaxhighlight>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:<syntaxhighlight lang="shell">$ git commit -a[master 0fde1fb] Added TODO in section "USING GIT" 1 files changed, 4 insertions(+), 0 deletions(-)</syntaxhighlight> ===Pushing Changes to Remote Repository=== <div classsyntaxhighlight lang="subcolumnsshell">$ git pushEnter passphrase for key '/home/user/.ssh/id_rsa': Everything up-to-date</syntaxhighlight> ===Create the project Pulling Changes from Remote Repository=== <div classsyntaxhighlight lang="c50lshell"> [[File$ git pullEnter passphrase for key '/home/user/.ssh/id_rsa':Git07Already up-to-date.png|border|300px|left]] Select our newly cloned </syntaxhighlight> ===Add Upstream Repository=== The upstream repository is the one from which the BaseX releases are made and click Nextthe one from which the personal repository was forked. <syntaxhighlight lang="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) </divsyntaxhighlight> ===Pulling Changes from Upstream to Local Repository=== When some changes are made in the upstream repository, they can be pulled to the local repository as follows: <div classsyntaxhighlight lang="c50rshell"> [[File$ git pull upstream masterEnter passphrase for key '/home/user/.ssh/id_rsa': From github.com:Git08BaseXdb/$project * branch master -> FETCH_HEADAlready up-to-date.png|border|300px|left]] Select </syntaxhighlight> The changes can then be pushed in the personal repository:<syntaxhighlight lang="shell">$ git push</syntaxhighlight> Check out the links at the end of the page for more git options.</td></tr></table> ===Developing a new feature or bug fix=== 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 ''Import Existing Projects'master''branch: <syntaxhighlight lang="shell" and depending >$ git pull upstream master</syntaxhighlight> Now, we create a new branch, based on the master branch <syntaxhighlight lang="shell">$ git checkout -b new-featureSwitched to a new branch 'new-feature'</syntaxhighlight> Your are now automatically switched to the ''new-feature'' branch. Now you can make all your Eclipse version enable automatic sharing. More recent versions will not offer this feature as sharing is enabled by defaultchanges in one or several commits.You can commit all changes using <syntaxhighlight lang="shell">$ git commit -a</syntaxhighlight> Click next Now, you want to push these changes to select the Project repository on GitHub. Remember, that up to importnow your changes just reside on your local drive, so now you want to push it to your remote fork of BaseX. Simply do:  <syntaxhighlight lang="shell">$ git push origin new-featureCounting objects: 318, done.Delta compression using up to 4 threads.Compressing objects: 100% (107/107), done.Writing objects: 100% (154/154), 22.96 KiB | 0 bytes/divs, done.Total 154 (delta 93), reused 81 (delta 26)To git@github.com:$username/basex.git * [new branch] new-feature ->new-feature</divsyntaxhighlight> You can now use your web browser and go to your fork of BaseX. You will see the following message: [[File:Git11.png]] You can now click the "Compare & pull request" button. You can now review the changes you are going to 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 more information please refer to: [http://help.github.com/git-installation-redirect/ GitHub: git Installation Guide]