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.

Requirements beforehand

Before, you must know how to use Git. If you don't know about 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.

For one specific step in this tutorial, you will need 6+ GB of free RAM.

You must have installed Java JDK 17 or higher.

On Windows: you should install WSL: just open PowerShell and type wsl --install. Then, install Java JDK 17 on WSL. 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