contributor-guide/doc/source/common/git.rst

Setup and Learn GIT

Note

This section assumes you have completed accounts guide.

Git

What is it?

Git is a free and open source distributed version control system that the OpenStack community uses to manage changes to source code.

Installation

Mac OS

1. Go to the Git download page and click Mac OS X.
2. The downloaded file should be a dmg in your downloads folder. Open that dmg file and follow the instructions on screen.

If you use the package manager Homebrew, open a terminal and type:

brew install git

Linux

For distributions like Debian, Ubuntu, or Mint open a terminal and type:

sudo apt install git

For distributions like RedHat, Fedora 21 or earlier, or CentOS open a terminal and type:

sudo yum install git

For Fedora 22 or later open a terminal and type:

sudo dnf install git

For SUSE distributions open a terminal and type:

sudo zypper in git

Windows

Windows Subsystem for Linux (WSL) is available in Windows 10 Anniversary Update or later (build 1607+). There is the possibility to install and run modern Linux Operating Systems:

• Ubuntu 16.04
• openSUSE Leap 42
• SLES 12

All common tools like bash, git, and SSH will work out of the box.

Although Git download page provides Windows installation binary, most OpenStack development tools (e.g., git-review) unfortunately will not work well on Windows environment.

Configure Git

Once you have Git installed you need to configure it. Open your terminal application and issue the following commands putting in your first/last name and email address. This is how your contributions will be identified:

git config --global user.name "Firstname Lastname"
git config --global user.email "your_email@youremail.com"

Note

Use the same email address that was used during the account setup.

Learning Git

You can use Git Immersion to work through tutorials for learning git.

For reference, use the Git Reference and Cheat Sheet.