The Wayback Machine - https://web.archive.org/web/20220313220835/https://docs.github.com/en/enterprise-server@3.1/get-started/quickstart/hello-world
Skip to main content
Enterprise Server 3.1
English
 
Get started
Enterprise Server 3.1
English

 

This version of GitHub Enterprise will be discontinued on 2022-06-03. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

Hello World

In this article

Follow this Hello World exercise to get started with GitHub Enterprise Server.

Introduction

GitHub Enterprise Server is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere.

This tutorial teaches you GitHub Enterprise Server essentials like repositories, branches, commits, and pull requests. You'll create your own Hello World repository and learn GitHub Enterprise Server's pull request workflow, a popular way to create and review code.

In this quickstart guide, you will:

  • Create and use a repository
  • Start and manage a new branch
  • Make changes to a file and push them to GitHub Enterprise Server as commits
  • Open and merge a pull request

To complete this tutorial, you need a GitHub Enterprise Server account and Internet access. You don't need to know how to code, use the command line, or install Git (the version control software that GitHub Enterprise Server is built on). If you have a question about any of the expressions used in this guide, head on over to the glossary to find out more about our terminology.

Creating a repository

A repository is usually used to organize a single project. Repositories can contain folders and files, images, videos, spreadsheets, and data sets -- anything your project needs. Often, repositories include a README file, a file with information about your project. README files are written in the plain text Markdown language. You can use this cheat sheet to get started with Markdown syntax. GitHub Enterprise Server lets you add a README file at the same time you create your new repository. GitHub Enterprise Server also offers other common options such as a license file, but you do not have to select any of them now.

Your hello-world repository can be a place where you store ideas, resources, or even share and discuss things with others.

  1. In the upper-right corner of any page, use the drop-down menu, and select New repository. Drop-down with option to create a new repository

  2. In the Repository name box, enter hello-world.

  3. In the Description box, write a short description.

  4. Select Add a README file.

  5. Select whether your repository will be Public or Private.

  6. Click Create repository.

    Create a hello world repository

Creating a branch

Branching lets you have different versions of a repository at one time.

By default, your repository has one branch named main that is considered to be the definitive branch. You can create additional branches off of main in your repository. You can use branches to have different versions of a project at one time. This is helpful when you want to add new features to a project without changing the main source of code. The work done on different branches will not show up on the main branch until you merge it, which we will cover later in this guide. You can use branches to experiment and make edits before committing them to main.

When you create a branch off the main branch, you're making a copy, or snapshot, of main as it was at that point in time. If someone else made changes to the main branch while you were working on your branch, you could pull in those updates.

This diagram shows:

  • The main branch
  • A new branch called feature
  • The journey that feature takes before it's merged into main

branching diagram

Have you ever saved different versions of a file? Something like:

  • story.txt
  • story-edit.txt
  • story-edit-reviewed.txt

Branches accomplish similar goals in GitHub Enterprise Server repositories.

Here at GitHub Enterprise Server, our developers, writers, and designers use branches for keeping bug fixes and feature work separate from our main (production) branch. When a change is ready, they merge their branch into main.

Create a branch

  1. Click the Code tab of your hello-world repository.
  2. Click the drop down at the top of the file list that says main. Branch menu
  3. Type a branch name, readme-edits, into the text box.
  4. Click Create branch: readme-edits from main.

Branch menu

Now you have two branches, main and readme-edits. Right now, they look exactly the same. Next you'll add changes to the new branch.

Making and committing changes

When you created a new branch in the previous step, GitHub Enterprise Server brought you to the code page for your new readme-edits branch, which is a copy of main.

You can make and save changes to the files in your repository. On GitHub Enterprise Server, saved changes are called commits. Each commit has an associated commit message, which is a description explaining why a particular change was made. Commit messages capture the history of your changes so that other contributors can understand what you’ve done and why.

  1. Under the readme-edits branch you created, click the README.md file.

  2. Click to edit the file.

  3. In the editor, write a bit about yourself. Try using different Markdown elements.

  4. In the Commit changes box, write a commit message that describes your changes.

  5. Click Commit changes.

    Commit example

These changes will be made only to the README file on your readme-edits branch, so now this branch contains content that's different from main.

Opening a pull request

Now that you have changes in a branch off of main, you can open a pull request.

Pull requests are the heart of collaboration on GitHub Enterprise Server. When you open a pull request, you're proposing your changes and requesting that someone review and pull in your contribution and merge them into their branch. Pull requests show diffs, or differences, of the content from both branches. The changes, additions, and subtractions are shown in different colors.

As soon as you make a commit, you can open a pull request and start a discussion, even before the code is finished.

By using GitHub Enterprise Server's @mention feature in your pull request message, you can ask for feedback from specific people or teams, whether they're down the hall or 10 time zones away.

You can even open pull requests in your own repository and merge them yourself. It's a great way to learn the GitHub Enterprise Server flow before working on larger projects.

  1. Click the Pull requests tab of your hello-world repository.

  2. Click New pull request

  3. In the Example Comparisons box, select the branch you made, readme-edits, to compare with main (the original).

  4. Look over your changes in the diffs on the Compare page, make sure they're what you want to submit.

    diff example

  5. Click Create pull request.

  6. Give your pull request a title and write a brief description of your changes. You can include emojis and drag and drop images and gifs.

  7. Optionally, to the right of your title and description, click the next to Reviewers. Assignees, Labels, Projects, or Milestone to add any of these options to your pull request. You do not need to add any yet, but these options offer different ways to collaborate using pull requests. For more information, see "About pull requests."

  8. Click Create pull request.

Your collaborators can now review your edits and make suggestions.

Merging your pull request

In this final step, you will merge your readme-edits branch into the main branch. After you merge your pull request, the changes on your readme-edits branch will be incorporated into main.

Sometimes, a pull request may introduce changes to code that conflict with the existing code on main. If there are any conflicts, GitHub Enterprise Server will alert you about the conflicting code and prevent merging until the conflicts are resolved. You can make a commit that resolves the conflicts or use comments in the pull request to discuss the conflicts with your team members.

In this walk-through, you should not have any conflicts, so you are ready to merge your branch into the main branch.

  1. Click Merge pull request to merge the changes into main. Screen shot of merge button.
  2. Click Confirm merge. You will receive a message that the request was successfully merged and the request was closed.
  3. Click Delete branch. Now that your pull request is merged and your changes are on main, you can safely delete the readme-edits branch. If you want to make more changes to your project, you can always create a new branch and repeat this process.

Next steps

By completing this tutorial, you've learned to create a project and make a pull request on GitHub Enterprise Server.

Here's what you accomplished in this tutorial:

  • Created an open source repository
  • Started and managed a new branch
  • Changed a file and committed those changes to GitHub Enterprise Server
  • Opened and merged a pull request

Take a look at your GitHub Enterprise Server profile and you'll see your work reflected on your contribution graph.

For more information about the power of branches and pull requests, see "GitHub flow." For more information about getting started with GitHub Enterprise Server, see the other guides in the getting started quickstart.