Tutorial: Contributing

This tutorial quickly shows you how to set up a fork of Gale so that you can make a pull request that modifies existing patches or adds new patches.

ℹ️    This tutorial is written for Gale,              but you can follow the same steps on any other fork!

Requirements beforehand

    ✔  You need to know how to open a command terminal and run commands

    ✔  You need to know how to use Git.
           If you don't know Git, check out a tutorial online (for example this one).
           Specifically, you should know how to do an interactive rebase in Git: git rebase -i
           (Check out this video, for example)

    ✔  You will need 6+ GB of free RAM

    ✔  You must have installed Java JDK 17 or higher

    ✔  You must have installed Git (or a Git client like GitHub Desktop, Sourcetree or IntelliJ IDEA)
           This tutorial will use Git on the command line (git command)

    ✔  (Windows only) On Windows: you should install WSL:

          ●   Open PowerShell and type wsl --install
          ●   Open a wsl command line (type wsl into Start and press Enter)
          ●  Install Java JDK 17 on WSL by running this command in the WSL command window:
              sudo apt-get update && sudo apt-get upgrade && sudo apt install openjdk-17-jdk openjdk-17-jre
          ●   Do everything in this tutorial on WSL

          (It is possible without WSL, but 100 things can go wrong, so I don't recommend it.)

1. Set up the project

Setting up the project is not a one-click step, but it's pretty easy.

1.1. Create a fork of the GitHub project

• Click Fork in the top-right corner of the Gale project page

  

• Click Create a new fork

  

• Click Create fork

  

2. How Paperweight works

3. How to use Paperweight most of the time

4. Brand your fork