From 828c9c2de6db6f2f8dd783e2613475d08c3b8cd6 Mon Sep 17 00:00:00 2001 From: Olivier Gagnon Date: Mon, 11 Oct 2021 16:28:01 -0400 Subject: [PATCH] improve contributing.md --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5abf64ead..604549106 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,6 +84,28 @@ changes are okay to contribute: - Changes that directly affect the game's balance - New gameplay mechanics +### How to setup fork properly + +Fork and clone the repo + +``` + # This will add the game original code as a repo in your local copy + $ git remote add danielyxie git@github.com:danielyxie/bitburner.git + + # You can verify you did this right by doing the following command + $ git remote show + danielyxie + origin + + # Then download all the branches from the game. (there might be more branches) + $ git fetch danielyxie + From github.com:danielyxie/bitburner + * [new branch] dev -> danielyxie/dev + * [new branch] master -> danielyxie/master + + # Makes sure you always start from `danielyxie/dev` to avoid merge conflicts. +``` + #### Submitting a Pull Request When submitting a pull request with your code contributions, please abide by