summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPliable Pixels <pliablepixels@gmail.com>2016-11-21 10:46:07 -0400
committerPliable Pixels <pliablepixels@gmail.com>2016-11-21 10:46:07 -0400
commit5cae32efc18eac4c3f6a4fe61fd6439d634c90b2 (patch)
tree951bd86478f02e0aa58f4823b88a3c50ca63adb4
parent76b17d856fe7ce6ccaa377e31a53a733920548df (diff)
added instructions on how to PR
-rw-r--r--CONTRIBUTING.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 37e902d4..0018f55b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,3 +4,53 @@ The source code will always be available under CC BY-NC-SA 4.0. If you'd like to
Thanks.
+
+##### Steps for code contribution
+
+It's best if you follow a proper process to contribute code - makes it easy for me to track/review. You will need `git`
+
+###### One time
+* checkout zmNinja and make sure you link it to my repository(you only need to do this once)
+
+* This sets up a local copy of my repo
+```
+git checkout https://github.com/pliablepixels/zmNinja.git
+```
+* This will link your repo to mine (needed for future pushes)
+```
+git add upstream https://github.com/pliablepixels/zmNinja.git
+```
+
+
+###### every time you want to contribute
+* cd `<wherever you cloned my repo>/zmNinja`
+
+* Make sure you have the latest version of my repo
+
+```
+git checkout master
+git pull upstream master
+
+```
+
+* Let's suppose you want to add some "new-feature"
+
+* Create an ISSUE on [zmNinja github issues](https://github.com/pliablepixels/zmNinja/issues)
+
+* Note down the issue number (lets say its 1234)
+
+* create a branch in your local git copy
+```
+git checkout -b 1234-new-feature (replace 1234 and new-feature)
+```
+
+You will now be in a new branch for you to develop the feature
+
+* You can keep testing your changes. Make sure you commit often via `git add <files>` and `git commit -m "comments on changes" .`(you are committing to your local copy, not my repo)
+
+* Once done, go to your github webpage and you will see a "create pull request" button in green. Review what you are doing a pull request for and click that button - I'll get an email you want me to review your changes
+
+
+
+
+