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== ===Clone=== * In the '''Package Explorer''' to the left, use right-click and choose '''Import...'''* Select '''Projects from Git''' and click '''Next'''* 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'''".  <gallery>File:Git01.png|Package ExplorerFile:Git02.png|Projects from GitFile:Git03.png|CloneFile:Git04.png|GitHub URIFile:Git05.png|Select BranchFile:Git06.png|Location</gallery> ===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 check out and click finish* You are now ready to contribute.  <gallery>File:Git07.png|Select RepositoryFile:Git08.png|Import existing ProjectsFile:Git09.png|Select basex Project</gallery> ===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. ==Using Git on Command-Line== '''Note''': this is not intended to be a complete git reference; its purpose is to quickly introduce BaseX developers to the most commonly used git commands in the context of the BaseX project. ===Preparation=== # Create a GitHubuser account: [https://github.com/signup/free here] (your github user name will be referenced as $username)# Set up SSH access to GitHub as described [https://docs.github.com/en/github/authenticating-to-github/connecting-to manage -github-with-ssh 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=== <syntaxhighlight lang="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</syntaxhighlight>Note that git automatically creates a directory where the repository content will be checked out. ===List Remote Repositories=== <syntaxhighlight lang="shell">$ git remote -vorigin git@github.com:$username/$project.git (fetch)origin git@github.com:$username/$project.git (push)</syntaxhighlight>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:<syntaxhighlight lang="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</syntaxhighlight> ===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:<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=== <syntaxhighlight lang="shell">$ git pushEnter passphrase for key '/home/user/.ssh/id_rsa': Everything up-to-date</syntaxhighlight> ===Pulling Changes from Remote Repository=== <syntaxhighlight lang="shell">$ git pullEnter passphrase for key '/home/user/.ssh/id_rsa': Already up-to-date.</syntaxhighlight> ===Add 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. <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)</syntaxhighlight> ===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: <syntaxhighlight lang="shell">$ git pull upstream masterEnter passphrase for key '/home/user/.ssh/id_rsa': From github.com:BaseXdb/$project * branch master -> FETCH_HEADAlready up-to-date.</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 ''master'' branch: <syntaxhighlight lang="shell">$ 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 changes in one or several commits. You can commit all changes using

Git makes Now, you want to push these changes to the repository on GitHub. Remember, that up to now your changes just reside on your local drive, so now you want to push it easy to retain a full copy your remote fork of the repository for yourselfBaseX.Simply do:

<syntaxhighlight lang==Using Git & Eclipse =="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/s, done.Total 154 (delta 93), reused 81 (delta 26)To git@github.com:$username/basex.git * [new branch] new-feature -> new-feature</syntaxhighlight>

# (Optional) Head over You can now use your web browser and go to [https://githubyour fork of BaseX.com/BaseXdb/BaseX GitHub] and create an account# Make yourself familiar with git, there are several tutorials around You will see the web# Install egit (Eclipsefollowing message: Help > Marketplace > Search for ''egit'' '''or''' get it from [http://www.eclipse.org/egit/ here])# Open Eclipse

<div class="subcolumns"> <div class="c50l"> [[File:Git01.png|border|300px|left]] In You can now click the '''Package Explorer''' to the left use right-click and choose Import... </div> <div class="c50r"> [[File:Git02.png|border|300px|left]] Select "'''Projects from Git'''" and click Next Compare &gt; </div></div><div class=pull request"subcolumns"> <div class="c50l"> [[File:Git03button.png|border|300px|left]] Click "'''Clone...'''" to create a local copy of You can now review 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 changes you want are going 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 credentialspush. </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: Pick &lt;workspace&gt;/repos/BaseX and click "'''FinishPlease review them carefully. Also, please give a meaningful comment so we can quickly determine what your changes are doing.'''After clicking the " </div></div>Create Pull request" button you are done and we will review your changes and either merge the pull request or get back to you.

<div class="subcolumns"> <div class="c50l"> [[File:Git07.png|border|300px|left]] Select our newly cloned repository and click Next </div> <div classLinks=="c50r"> [[File:Git08.png|border|300px|left]] 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 </div></div>

<div class="subcolumns"> <div class="c50l"> [* [Filehttps:Git09//docs.github.png|border|300px|leftcom/en/github/getting-started-with-github/set-up-git GitHub: git Installation Guide]] Check "basex" to checkout and click finish <* [https:/div>/help.github.com/ Comprehensive Getting Starting Guide on GitHub] <div class="c50r"> * [[Filehttps:Git10//book.png|border|300px|left]] You are now ready to contributegit-scm. <com/div></div>The git book]