Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 1.56 KB

get-setup.md

File metadata and controls

47 lines (29 loc) · 1.56 KB
Raw

Get Setup

In order to contribute, you must first install Git on your machine:

Installing Git

The easiest way to get all the Git tools is to download GitHub Desktop. This will install Git, Git shell, GitHub Desktop, and keep you up to date.

Setting up Jekyll on Windows

  1. Follow the Jekyll on Windows guide.
  2. Install Rouge

gem install rouge --no-ri

Fork the repository

  1. Create a GitHub account 
  2. From GitHub Home, navigate to the repository you'd like to contribute to (e.g. ms-iot/content)
  3. Click Fork Fork 
  4. Clone the repository in one of several ways: 
  5. Command line 
`git clone [link to forked .git] [NameYourLocalFolder] `

  1. Launch the GitHub app 

    Click 'Clone in Desktop'

    Clone

  2. Clone using the GitHub Desktop application. 

  3. Using your own git flow (e.g. sourcetree) 

For clarification:

local repository:: the cloned repository that you have one on your machine 

forked repository:: the fork you made from the main repository. This sits up on GitHub's servers. (Also known as "origin") 

main repository: the original repository that you forked from. This is the common ms-iot repository hosted on GitHub's servers. (Also known as "upstream")

How to contribute

  1. Get set up
  2. Making changes
  3. Authoring guidelines and best practices