From e49e020f0a6dfb00c9a866a6b2f4535fb2e464f5 Mon Sep 17 00:00:00 2001 From: LeMagnesium Date: Tue, 19 May 2015 14:51:57 +0200 Subject: [PATCH] Updated REAME.md with developpers' tips --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 53 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5366fc03..5c984090 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Contributors - mgl512 > Helper for debugging, who leaves useful comments. - Ataron - > Occasionnal debogger, texture fixer. + > Occasionnal debogger, texture creater. - Gael-de-Sailly > Kittens carer, and debogger. - davedevils @@ -42,10 +42,61 @@ Contributeurs - mgl512 > Aide au déboggage, laisse aussi des commentaires très utiles. - Ataron - > Déboggueur occasionnel. + > Déboggueur occasionnel, créateur de textures - Gael-de-Sailly > Soigneur et deboggueur de chatons. - davedevils > Jardinier, père des creeper et ami des poulets. - Obani > Roi du bit audio. + +Note to developpers +=================== + +Recently many changes have been made in the repository. New methods have been +adopted for pushing/pulling from the repository. You will find here the most +importants + +### When you are pushing +After committing, you will need to reproduce your changes on parallel branches. +For example, if you commit on master : + + > git format-patch HEAD~ --stdout > patch_for_branch.patch + > # Created a .patch file to apply commits on the other branch + > git checkout + > git am ./patch_for_branch.patch # Apply the patch + > git push origin + +If you want to see which files are being modified, or how many lines are added : + + > git apply --stat < patch_for_branch.patch + another_file.txt | 0 + another_file.txt | 0 + 2 files changed, 0 insertions(+), 0 deletions(-) + > + +If you want to check whether or not you will have to resolve merge conflicts : + + > git apply --check < patch_for_branch.patch + +If you get errors, then git am will require you to solve merge conflicts. + +### When a parallel branch cannot be pulled +WIP works are often put on parallel branch to not disturb simple +updates or fixes for mods (even if they should be reproduced on these +branches as shown above). However, there might be problems, requiring +devs to 'forcepush' on the branches. +__*Note:*__ It will never happen on `master` + +If you cannot pull, then, here is what to do : + + > git checkout master + > git branch -D + > git checkout -b + > git branch --set-upstream-to=origin/ + > git pull origin + +This will delete your copy of the branch, create a new one, and replace +it with the remote content. You can also : + + > git pull --force