Skip to content
Brenton Strine edited this page Jul 25, 2019 · 19 revisions

General overview video

This video shows generally how we will be using GitHub to stay organized and collaborate.

Video Tutorial

How to create a PR

Video Tutorial

How to set up your local repository to contribute

Set up local Repo
  1. Fork the upstream repo
  2. Clone your fork to your computer
  3. Merge from Upstream

Video Tutorial

How to merge from upstream

  1. Click the branch menu
  2. Click the button "Choose a branch to merge into master"
  3. Select Upstream
  4. Click the button "Merge into master"

Video Tutorial

Branches that track Upstream

(Full article: https://github.com/team-refcode/refcode.org/wiki/How-to-contribute-to-Refcode1.0)

It's possible to have branches that don't track your fork, but track upstream instead. In fact, you will need to use branches that track upstream in order to contribute to the old codebase, which is on upstream refcode1.0. This video explains it:

Deployment

Code merged into master is not automatically deployed to refcode.org. Instead, it is deployed to a staging area that is visible at https://master--refcode.netlify.com/.

In order for code to be visible on refcode.org, it must be merged into the prod branch. After any merge to prod everything on that branch will be deployed to refcode.org and will "go live" within minutes.

Netlify is the web server that hosts refcode.org and manages the deployment.

Pattern Library

The pattern library can be viewed at https://master--refcode.netlify.com/patternlibrary.html.