Skip to content

Latest commit

 

History

History
125 lines (70 loc) · 3.26 KB

README.md

File metadata and controls

125 lines (70 loc) · 3.26 KB

Contributing to this book

This book is written using mdBook. To contribute to this book, you will need:

  1. mdBook
  2. git
  3. GitHub account
  4. (Optional) VSCodium

VSCodium or VSCode is highly recommended to use. Although it is optional, I will assume you are using it.

Below I describe the setup steps needed to run and contribute to this book. But before that, go and install VSCodium and Git.

Forking book repository

Contributing to this book follows the standart "Pull Request" workflow. That basically means that you will have your own copy of the book, and you will ask us to pull your changes into the main repository.

Here is the overview of steps needed for contributing:

  1. Copy ("fork") the main repository
  2. Download your copy of repo
  3. Add your changes to your copy
  4. Upload your changes
  5. Open the Pull Request to merge your changes into main repository

Welp, let's get started. I hope you already have a GitHub account.

Forking

  1. Go to the main repo
  2. Press the fork button

Mod Organiser logo

  1. Create the fork

Mod Organiser logo

  1. You're awesome

Downloading your repo

  1. Open the folder you want to download into in VSCodium. In my case, it will be Desktop.

Mod Organiser logo

  1. Open Poweshell Terminal session
  2. Copy the link to your repo.

Mod Organiser logo

  1. Run the following command in your Powershell Terminal with your link instead of LINK.
git clone LINK
  1. You're awesome.

Running local copy

  1. Download latest mdbook from Github Releases.
  2. Drop mdbook.exe in the root folder of your copy.
  3. Run run.bat. In case it doesn't open by itself, open localhost:3000 in your browser.
  4. Done. You're awesome.

Uploading your changes

  1. Set your git up. Here's a great guide

  2. Add your changes using VSCodium git tab. Open git tab, hover over "Changes" line and press "+".

Mod Organiser logo

  1. Add a nice message and press "✔" to commit your changes

Mod Organiser logo

  1. You should now be able to publish your changes

Mod Organiser logo

Creating Pull Request

  1. In main book repository, open "Pull Requests" tab and press "New pull request"

Mod Organiser logo

  1. Press "compare across forks". Choose your repository and press "Create pull request".

  2. You're awesome. Probably. Now ping Igigog#6387 in Discord to get your pull request reviewed.

  3. Done. Your changes are added to the main book.