Using GitHub in Modding Projects

[BaconWizard17]

USING  GITHUB  IN  MODDING  PROJECTS
AN OVERVIEW

By BaconWizard17

Introduction
    GitHub is a platform, often used in code projects, that allows you to host your files in a specific location, share them, and control their revisions. It has many uses in modding projects, as it can show differences in code, allow you to revert to old files, and collaborate with others. This tutorial is an abbreviated version of this official one on the GitHub Desktop documentation.

Setting Up GitHub Desktop
    GitHub Desktop is the way to use GitHub on your computer. Here's how to set it up.

Expand to see steps

• Go to github.com and set up an account.
• Download and install GitHub Desktop. Be sure to log in after opening it.
• If this is your first time using GitHub Desktop, you'll get the "Let's Get Started" screen. Choose "Create a New Repository on your Hard Drive..."
  
  
• If you've previously used GitHub Desktop, then at the top left of GitHub desktop, go to File>New Repository.
  
  
• When the "Create a new repository" window appears, first type the name of the folder in "Name." It doesn't matter what this is, but make sure it describes your project (note that any spaces will be replaced with dashes, and certain characters, like apostrophes, are not allowed). The other thing you can change is the "Local Path." I recommend a short path, like C:\GitHub. You don't need to change any other settings. After this, click "Create."
  
  
• With your repository created, you can now publish it! To do this, click the "Publish repository" button at the top middle of the screen (or the other one in the middle of the screen). In the next screen, you'll get the option to change any details about the repository. You can also control if the repository is private or not.
  
       
• Publishing your repository will allow you to access this repository from any device and share it with others. You're now ready to start managing files!

Using GitHub Desktop
    Once you've set up GitHub Desktop, you can start using it to keep track of your files. Here's how it works.

Expend to see steps

• Whenever you add a file into the repository folder, make changes to an existing file, or delete a file, that will show up on the left side of the screen.
  
  
• Any time you're satisfied with your current files, you can write your commit. A commit is like a freeze frame that captures all the files in their current state. Generally, this is done when you've completed something within your project (like finishing writing a power or completing a skin), but you can do it at any time. To make a commit, add a title to it at the bottom left corner. Make sure it describes what you've changed since last time, but keep it brief. You can put an extended description below if needed, which I recommend. Once you're done with that, simply click "Commit to main" at the bottom left.
  
  
• After making your commit, you'll have the option to "Push origin" at the top middle. This will push the changes from being local on your computer to being hosted online, allowing you to access the files from anywhere.
  
  
• After you make a commit, any new changes that you make will be tracked from that point.
  
  
• If you're not happy with changes that you've made, you can discard them by right clicking and choosing "discard."
  
  
• If you're working with others on a repository, make sure you always click on "Pull Origin" before you make any changes or commits, as you might get conflicts otherwise.
  
  

Learning More
    This tutorial only touches on the very surface-level features of GitHub, but it has lots more capabilities. It's a widely used platform, so you can find lots of information online. The best place to start is the official GitHub Desktop documentation.