github.com/demonoid81/moby@v0.0.0-20200517203328-62dd8e17c460/docs/contributing/software-required.md (about) 1 ### Get the required software for Linux or macOS 2 3 This page explains how to get the software you need to use a Linux or macOS 4 machine for Moby development. Before you begin contributing you must have: 5 6 * a GitHub account 7 * `git` 8 * `make` 9 * `docker` 10 11 You'll notice that `go`, the language that Moby is written in, is not listed. 12 That's because you don't need it installed; Moby's development environment 13 provides it for you. You'll learn more about the development environment later. 14 15 ## Task 1. Get a GitHub account 16 17 To contribute to the Moby project, you will need a <a 18 href="https://github.com" target="_blank">GitHub account</a>. A free account is 19 fine. All the Moby project repositories are public and visible to everyone. 20 21 You should also have some experience using both the GitHub application and `git` 22 on the command line. 23 24 ## Task 2. Install git 25 26 Install `git` on your local system. You can check if `git` is on already on your 27 system and properly installed with the following command: 28 29 ```bash 30 $ git --version 31 ``` 32 33 This documentation is written using `git` version 2.2.2. Your version may be 34 different depending on your OS. 35 36 ## Task 3. Install make 37 38 Install `make`. You can check if `make` is on your system with the following 39 command: 40 41 ```bash 42 $ make -v 43 ``` 44 45 This documentation is written using GNU Make 3.81. Your version may be different 46 depending on your OS. 47 48 ## Task 4. Install or upgrade Docker 49 50 If you haven't already, install the Docker software using the 51 <a href="https://docs.docker.com/engine/installation/" target="_blank">instructions for your operating system</a>. 52 If you have an existing installation, check your version and make sure you have 53 the latest Docker. 54 55 To check if `docker` is already installed on Linux: 56 57 ```bash 58 docker --version 59 Docker version 17.10.0-ce, build f4ffd25 60 ``` 61 62 On macOS or Windows, you should have installed Docker for Mac or 63 Docker for Windows. 64 65 ```bash 66 $ docker --version 67 Docker version 17.10.0-ce, build f4ffd25 68 ``` 69 70 ## Tip for Linux users 71 72 This guide assumes you have added your user to the `docker` group on your system. 73 To check, list the group's contents: 74 75 ``` 76 $ getent group docker 77 docker:x:999:ubuntu 78 ``` 79 80 If the command returns no matches, you have two choices. You can preface this 81 guide's `docker` commands with `sudo` as you work. Alternatively, you can add 82 your user to the `docker` group as follows: 83 84 ```bash 85 $ sudo usermod -aG docker ubuntu 86 ``` 87 88 You must log out and log back in for this modification to take effect. 89 90 91 ## Where to go next 92 93 In the next section, you'll [learn how to set up and configure Git for 94 contributing to Moby](set-up-git.md).