diff --git a/Developer-notes.md b/Developer-notes.md index 50352d0..29c9500 100644 --- a/Developer-notes.md +++ b/Developer-notes.md @@ -14,19 +14,19 @@ This is a step-by-step guide to keep your forked copy of Cxbx-Reloaded updated, If you want more informations about git commands, you can read this free book: https://git-scm.com/book/en/v2 Special thanks to @PatrickvL and @RadWolfie. -# First time setup (aka adding the upstream remote) +### First time setup (aka adding the upstream remote) You have to follow these steps only the firt time you fork Cxbx-Reloaded: 1) Fork mainline Cxbx-Reloaded repository on GitHub by clicking the "Fork" button (upper-right) and clone it to your hard drive. 2) Open a git shell in the root directory of your cloned repo and paste this command (without quotes): "git remote add upstream https://github.com/Cxbx-Reloaded/Cxbx-Reloaded.git". 3) Now type (without quotes) "git remote -v". If you see two "origin" and two "upstream": congratulation, you have completed the first time setup. -# Keep your fork updated +### Keep your fork updated You have to follow these steps anytime you want to update your forked Cxbx-Reloaded repo: 1) Open a git shell in the root directory of your cloned repo and paste these commands (without quotes): "git fetch upstream" and then "git checkout master". 2) Now type (without quotes): "git rebase -i upstream/master" and check if every commit looks good. 3) You may need to run (without quotes): "git push origin master --force" to update your repo on GitHub. -# Create a branch for your new contribution +### Create a branch for your new contribution You should keep the master branch of your forked repo clean, and instead create a new branch for every contributions you want to send. Before creating a branch MAKE SURE THAT YOUR FORK IS UP-TO-DATE! Please change "name_of_new_branch" with something meaningfull like "fixing-issue-X".