View source for Git for Coders

=Setup=
== GitHub Work Flow for Joomla! ==

[[File:Github work flow joomla.png]]

== Create Your Forked Repository on GitHub==
GitHub allows you to create your own copy of any public repository, including the Joomla CMS. This is your personal copy of the repository and is called a "fork". To create a fork of the Joomla CMS:
# If you haven't already, register on GitHub.com and log in.
# Navigate to [https://github.com/joomla/joomla-cms https://github.com/joomla/joomla-cms]
# Click on the Fork button in the upper right part of the screen.

Note that you can only create one fork of any given repository. However, as we will see, you can create as many branches (versions) of your repository as you like.

== Clone Your GitHub Repository To Your PC ==
At this point, you have your own repository on GitHub.com. Now you need to create a local repository that is a copy (called a "clone") of the GitHub repository. To do this:
===CLI (command line) Commands===
# Change directory to the directory where you want the Joomla files to be stored (for example, <code>C:\xampp\htdocs\joomla\my-project</code> or <code>/opt/lampp/htdocs/joomla/my-project</code>).
# Enter the command: <code>git clone <nowiki>https://github.com/<your GitHub user name>/joomla-cms.git</nowiki> .</code> For example, if your GitHub user name is "joomla-coder", the command would be: <code>git clone <nowiki>https://github.com/joomla-coder/joomla-cms.git</nowiki>  .</code> 

You can get the URL for the command above from your repository at GitHub.com as shown below. [[File:git-coders-tutorial-20121009-03.png|frame|none]]

Note that the "." dot just tells Git to put the new repository in the current directory. The system will work for a few minutes while it downloads all of the files. When it is finished, you will have a complete set of Joomla files under version control in the current directory.

=== Eclipse Commands ===
# If you like, you can get the URL from GitHub as shown below. [[File:git-coders-tutorial-20121009-03.png|frame|none]] You will use this later on.
# In Eclipse, open the Git Repositories view and click the button called "Clone a Git Repository and add the clone to this view" as shown below. [[File:git-coders-tutorial-20121009-01.png|frame|none]]
# The window below will show. [[File:git-coders-tutorial-20121009-02.png|frame|none]] Select URI and click Next.
# The window below will show. [[File:git-coders-tutorial-20121009-04.png|frame|none]] Enter the GitHub URL for your repository (from step (1) above). Enter your GitHub user name and password and check the box called "Store in Secure Store". 
# Click Next and the window below will show. [[File:git-coders-tutorial-20121009-05.png|frame|none]]
# Click Next to select all branches. The window below will show. [[File:git-coders-tutorial-20121009-06.png|frame|none]]
# In Directory, enter the folder where you want the Joomla files to be copied. Keep the default values for Initial branch ("master") and Remote name ("origin") as shown.
# Click Finish. The system will work for a few minutes. When it finishes you will have a clone of the remote repository.

== Create an Upstream Remote==
Now we have our local repository. This has a remote called "origin" that points to our personal fork of Joomla on GitHub. 

In a project like Joomla, many users are submitting bug fixes and features. These changes are committed to the main Joomla CMS repository frequently. It is up to each coder to keep their personal repositories up to date with these changes. Fortunately, as we will see, this is easy to do.

The last step in the setup is to create a second remote called "upstream" that points to the main Joomla CMS repository. We will use this remote to pull changes that others make to the main Joomla repository so we can keep our personal repositories up to date.

===CLI Command ===
To create a remote called "upstream" that points to the main CMS repository, enter this command: 

<code>git remote add upstream <nowiki>https://github.com/joomla/joomla-cms.git</nowiki></code>

Note, if you get a error like "fatal: Not a git repository (or any of the parent directories): .git", then make sure you've changed directory to the new repository that's been created within the current directory (so one level lower).

===Eclipse Command===
''Unknown at this time.''

At this point, you have your personal remote repository (created by "forking" the Joomla CMS project) and your personal local repository (created with CLI or Eclipse). Now you are ready to code patches and features.