Changes

==Using Git to contribute to BaseX ==

==Using Git & Eclipse==

===Clone===

* In the '''Package Explorer''' to the left, use right-click and choose '''Import...'''

* 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 <workspace>'''/repos/BaseX''' and click "'''Finish'''".

===Create the project ===

* 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

* You are now ready to contribute.

===EGit & SSH===

==Using Git on Command-Line==

===Preparation===

# Create a GitHub user account: [https://github.com/signup/free here] (your github user name will be referenced as $username)

# 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===

$ git clone git@github.com:$username/$project.git

Cloning into $project...

$ ls -d -1 $PWD/*

/home/user/myprojects/$project

Note that git automatically creates a directory where the repository content will be checked out.

===List Remote Repositories===

$ git remote -v

origin git@github.com:$username/$project.git (fetch)

origin git@github.com:$username/$project.git (push)

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.

After some files have been changed locally, the changes can be seen as follows:

$ git diff

diff --git a/readme.txt b/readme.txt

Any kind of feedback is welcome; please check out the online documentation at

===Commit to Local Repository===

First, it is needed to select the modified files which should be committed:

$ git add readme.txt

Then perform the actual commit:

$ git commit

[master 0fde1fb] Added TODO in section "USING GIT"

1 files changed, 4 insertions(+), 0 deletions(-)

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:

$ git commit -a

[master 0fde1fb] Added TODO in section "USING GIT"

1 files changed, 4 insertions(+), 0 deletions(-)

===Pushing Changes to Remote Repository===

$ git push

Enter passphrase for key '/home/user/.ssh/id_rsa':

Everything up-to-date

===Pulling Changes from Remote Repository===

$ git pull

Enter passphrase for key '/home/user/.ssh/id_rsa':

Already up-to-date.

===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.

$ git remote add upstream git@github.com:BaseXdb/$project.git

upstream git@github.com:BaseXdb/$project.git (fetch)

upstream git@github.com:BaseXdb/$project.git (push)

===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:

$ git pull upstream master

Enter passphrase for key '/home/user/.ssh/id_rsa':

* branch master -> FETCH_HEAD

Already up-to-date.

The changes can then be pushed in the personal repository:

$ git push

Check out the links at the end of the page for more git options.

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:

$ git pull upstream master

Now, we create a new branch, based on the master branch

$ git checkout -b new-feature

Switched to a new branch 'new-feature'

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 commit -a

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 to your remote fork of BaseX. Simply do:

$ git push origin new-feature

Counting objects: 318, done.

To git@github.com:$username/basex.git

* [new branch] new-feature -> new-feature

You can now use your web browser and go to your fork of BaseX. You will see the following message:

==Links==