GitHub Guide

<- (Previous) Design Principles & Goals | Viewing Changes In Game (Next) ->

GitHub Explained & Definitions

GitHub is a code hosting platform for version control and collaboration, powered by Git. For anyone unfamiliar with using Git it can be confusing and difficult to use, however for the most basic and essential purposes of Git it is quite simple to use, and for contributors to this rework the workflow is very simple.

If you need any further help for anything Git / GitHub related not covered here, refer to the official GitHub documentation:

• GitHub Official Documentation
• GitHub Official Guides

Or the official Git documentation:

• Git Documentation

Git can be used in a few different ways:

• Git Command Line tool - This is the "preferred" way of using Git but also the most complicated, and it is completely optional
• Git GUI tools - Git with an interface, very useful for beginners or anyone that does not want / need to use a command line. There are other clients available but GitHub's own tool is linked here
• GitHub web interface - The GitHub website can be used to do most functions you will need, especially for this rework. The main downsides are no locally stored files and limited functionality

Definitions

There are some terms that users will need to know to understand how Git works, but it isn't necessary to fully understand how it works to use it. If you want to understand how Git works refer to the documentaion linked above.

• Repo / Repository
• Fork
• Clone
• Commit
• Push
• Pull
  • Fetch
  • Merge
• Pull Request / PR
• Branch