Skip to content

Latest commit

 

History

History
96 lines (70 loc) · 3.83 KB

git-branch-setup.md

File metadata and controls

96 lines (70 loc) · 3.83 KB
Raw

Git branch setup

This document describes how to set up your development environment and contribute changes to accessibility-insights-web. This document assumes basic working knowledge with Git and related tools.We are providing instructions specific to this project.

Creating your own fork

If you wish to contribute changes back to the accessibility-insights-web repository, start by creating your own Fork of the repository. This will keep the number of branches on the main repository to a small count. In your own fork, you can create as many branches as you like.

  • Navigate to GitHub with a browser and log in to your GitHub account. For the sake of this document, let's assume your username is ada-cat.
  • Navigate to the accessibility-insights-web repository in the same browser session.
  • Click on the Fork button at the top right corner of the page.
  • Create the fork under your account. Your GitHub profile should now show accessibility-insights-web as one of your repositories.

Cloning your fork

  • Create a folder on your device and clone your fork of the accessibility-insights-web repository using one of the following commands. Notice how your GitHub username is in the repository location.

    • Using HTTPS 
      > git clone https://github.com/ada-cat/accessibility-insights-web.git
    • or if you prefer SSH 
      > git clone git@github.com:ada-cat/accessibility-insights-web.git

  • Select the created directory

    > cd accessibility-insights-web

Setting up the upstream repository

Before starting to contribute changes, please setup your upstream repository to the primary accessibility-insights-web repository.

  • When you run git remote -v, you should see only your fork in the output list

    > git remote -v
origin  https://github.com/ada-cat/accessibility-insights-web (fetch)
origin  https://github.com/ada-cat/accessibility-insights-web (push)

  • Map the primary accessibility-insights-web as the upstream remote

    > git remote add upstream https://github.com/Microsoft/accessibility-insights-web

  • Now running git remote -v should show the upstream repository also

    > git remote -v
origin  https://github.com/ada-cat/accessibility-insights-web (fetch)
origin  https://github.com/ada-cat/accessibility-insights-web (push)
upstream        https://github.com/Microsoft/accessibility-insights-web (fetch)
upstream        https://github.com/Microsoft/accessibility-insights-web (push)

  • At this point you are ready to start branching and contributing back changes.

Making code changes and creating a pull request

Create a branch from your fork and start making the code changes. Once you are happy with the changes, and want to merge them to the main accessibility-insights-web project, create a pull request from your branch directly to "Microsoft/accessibility-insights-web main".

Merging upstream main into your fork main

From time to time, your fork will get out of sync with the upstream remote. Use the following commands to get the main branch of your fork up to date.

git fetch upstream
git checkout main
git pull upstream main
git push

Merging upstream main into your current branch

Use these commands instead if you would like to update your current branch in your fork from the upstream remote.

git fetch upstream
git pull upstream main
git push