Joomla! Documentation™

Вступление

Этот документ предоставит информацию о том, как сделать вклад в Joomla! CMS с помощью Git и GitHub. Если вы хотите сделать простое изменение (только в одном файле), то это проще сделать с помощью этой документации: использование пользовательского интерфейса (UI) Github для создания pull request. Если вы хотите сделать более комплексные изменения или вам это просто интересно, то продолжайте читать!

Что такое Git и GitHub?

Git это распределенная система контроля версий. Эта система записывает изменения в файл и хранит эти изменения в файле истории. Вы всегда можете взглянуть назад на старые версии вашего кода и восстановить их если требуется. Так как история записывается, Git очень полезен, когда вы работаете вместе с множеством людей над одним проектом.

Here is how GitHub can be used. GitHub is an website that helps manage Git Projects in a visual way. As owner of a project you can change the code and compare different versions. As a user of the project you can contribute by making a Pull Requests. A pull request is a request to the owner to pull some code into the project. You're offering a piece of code (perhaps a solution for a bug) and asking if the Project owner would like to use it. If the owner likes it, he can merge (add) it to his project.

Joomla! использует GitHub и Git для управления кодом. Каждый может вносить вклад в программное обеспечение Joomla! Ссылка проекта Joomla! CMS на GitHub: https://github.com/joomla/joomla-cms

Начинаем

Регистрация на GitHub и установка Git

Сперва необходимо зарегистрироваться на GitHub. Это бесплатно и легко сделать. Просто следуйте предоставляемым инструкциям.

После регистрации необходимо установить Git. Последнюю версию Git можно найти здесь http://git-scm.com. Загрузите и откройте установщик. Git — это программа для CLI (Command Line Interface (интерфейс командной строки)). В начале может казаться всё запутанным или может быть немного страшно, но этот документ проведет вас через весь процесс.

Если вы не продвинутый пользователь, тогда просто запустите установщик и нажмите кнопки "next" пока программа не будет установлена. Git не повредит вашу систему. Позже, если захотите, то сможете удалить его как и любую другую программу.

После установки Git, запустите программу под названием "Git Bash". Откроется командная строка. Сообщите Git своё имя (ник) и адрес электронной почты. Git будет использовать эту информацию, когда вы будете вносить вклад в проект. С помощью следующих команд мы дадим эту информацию Git:

git config --global user.name "Your name"
git config --global user.email youremail@mail.com

В предыдущих командах и во всех следующих командах из этой документации каждая новая строка с символами это новая команда. Так что вы вводите первую строку с командой, нажимаете "Enter" и, затем, вводите следующую строку и опять "Еnter".

Теперь вы готовы к использованию Git. Следуйте дальше для настройки тестовой установки.

Настройка тестовой инсталляции

Для нашей тестовой установки нужен веб-сервер, который позволит вам установить и запустить Joomla! на вашем компьютере. Существуют множество программ, которые выполняют функции MAMP и XAMPP. Загрузите и установите одну из них.

After the installation of such a program (I use MAMP in this documentation), we going to install the latest version of Joomla!. In our case, the latest version of Joomla! is not the last stable release. The last version of Joomla! is the staging branch on GitHub. First, let me explain a little bit more about GitHub.

Fork and Clone Joomla!

На GitHub вы можете найти проекты, так называемые репозитории (repositories). Внутри проекта вы можете найти несколько версий. Такие версии называются ветками (branch). В Joomla! есть следующие ветки:

• Staging: эта ветка содержит последние исправления ошибок и новые возможности Joomla!
• Master: эта ветка содержит текущую стабильную версию Joomla!
• 3.5-dev эта ветка содержит файлы Joomla! 3.5, которая не стабильна на момент написания статьи.

On our test location we going to use the Staging branch but if we should use this branch directly we have problem. We cannot modify this branch because we are not the owner of it. We are going to make a copy of it. On GitHub this is called a Fork. We are the owner of that copy so we can modify it. After modifying we compare our fork with the original project. Then we can make a Pull Request for the changes we've made. More about that later. You can Fork a branch by pressing the Fork button on the Joomla! CMS Github Repository. This button is located at the right top of the page.

After forking, we are going to install Joomla! on our local Web server. Go to the folder were you can run files on you Web server. Most of the program use a folder called htdocs. Once we are inside that folder, press the right mouse button an click on: "Git Bash Here". The command line will open for this location.

Type the following command to download the files from your Fork of the Joomla! CMS to your computer. Please replace username with the username you are using on GitHub.

git clone https://github.com/username/joomla-cms.git

For all commands given in this documentation, you have to open Git via the above described steps. Please remember that for other commands in this documentation.

Once Git is ready, open your browser and go to the installation on your localhost. Usually the URL is something like: http://localhost/joomla-cms. You will now see the default Joomla! installation process.

Установка Joomla!

Установка Joomla! для нашей локальной тестовой установки в основном такая же как и обычная установка. Есть только две небольшие разницы.

For the database settings, the password and username are default. Most often the username is root and the password is also root or there is no password. If you still can't connect to the database, look in the manual for your local Web server for the username and password.

The last difference is the final step of the installation. Normally we must delete the installation folder to go further to the back-end or front-end of Joomla!. For a test installation we can skip this part and go directly to the back-end or front-end. Don't remove the installation folder. It can be very useful when we have to install Joomla again.

Делаем свои изменения

Now it is time to made our file changes to Joomla!. All changes we make will be registered and monitored by Git. At any moment you can type the command git status to see which files are modified or untracked. Untracked means that the file at that location is new for Git.

Если вы сделали ошибку или хотите восстановить файл, используйте следующую команду:

git checkout path/to/file

Если вы хотите удалить все изменения которые вы сделали, используйте следующие команды:

git checkout .
git clean -f -d

Первая команда сбрасывает все файлы. Вторая команда удаляет неотслеживаемые файлы и папки.

Push the Change to the Fork

After making our changes, we have to upload our changes to our repository on GitHub. After that, we can make a pull request with our changes.

Uploading changes is called push in Git terms. Before we can do that, we have to do something very important. We must create a new branch for our changes. (A branch is a version of our project, remember?) If we don't do that and made our change directly to the staging branch, the first time there won't be a problem. But if we made changes for the second time, and the change we made the first time are not merged yet, all these changes will registered too as new changes.

So the first command we are going to run will create a new branch. It will prevent the above described problem. Replace name-new-branch with the name of the new branch. This name must be short, and can only contain lower case letters and numbers. Do NOT use spaces. Instead of spaces, use - (minus).

git checkout -b name-new-branch

The next command tells git that all made changes are good, and are ready to commit.

git add --all

The following command adds our change to the branch. Please replace the message with a short description of your changes. This description will be the title of the pull request we are going to make.

git commit -m "description"

The final command will push (upload) the changes to our fork. Please replace name-new-branch with the name of the branch you made a few steps above.

git push origin name-new-branch

Compare Forks and Make a Pull Request

After pushing our change to GitHub, go to your fork of the Joomla! CMS.

Дополнительная информация

Because the staging version of Joomla! can change any moment, it is very useful to have the possibility for keeping our fork up-to-date. We can do that by adding a remote to our forked project:

git remote add upstream https://github.com/joomla/joomla-cms.git

We now added a remote called "upstream". With the following command, Git will search for new contribution (commits) in the staging branch we don't have in our fork. If it found some, it will add them to our fork:

git pull upstream staging

The changes are now only made on our local fork. To upload them to GitHub use the following command:

git push