Skip to content

How to contribute

Jasper van Riet edited this page Jun 15, 2022 · 1 revision

Editing an existing file

  1. Go to https://github.com/Liquipedia/Lua-Modules and navigate to the file you want to change
  2. Select the correct branch you want to commit into (for new PRs it is main)
  3. Click the edit button (little pen)
  4. Make your changes
  5. At the bottom add a good commit summary. Use the imperative present tense, e.g. "Make X do Y"
  6. a) If you want to open a PR:

toggle "Create a new branch for this commit and start a pull request". Give the branch a descriptive name, e.g. make-x-do-y

  1. b) If you want to commit to an existing branch (not main!):

toggle "Commit directly to the [...] branch"

  1. Click "Commit changes"

Creating a new file

  1. Go to https://github.com/Liquipedia/Lua-Modules and navigate to the directory where you want to create the file
  2. Select the correct branch you want to commit into (for new PRs it is main)
  3. Click "Add file" -> "Create new file"
  4. Make your changes
  5. At the bottom add a good commit summary. Use the imperative present tense, e.g. "Make X do Y"
  6. a) If you want to open a PR:

toggle "Create a new branch for this commit and start a pull request". Give the branch a descriptive name, e.g. make-x-do-y

  1. b) If you want to commit to an existing branch (not main!):

toggle "Commit directly to the [...] branch"

  1. Click "Commit changes"
Clone this wiki locally