issue ifmeorg#649 - added instructions for pull request and syncing t…

…o WORKFLOW.md

WORKFLOW.md

@@ -53,6 +53,30 @@ You can read about Rubocop [here](http://rubocop.readthedocs.io/en/latest/).
 Make a fork of the repository, create a new branch for every feature you are
 working on! **Always make pull requests!**
 
+### HOWTO: Pull Requests & Syncing
+
+1. Fork the if me repo (if you haven't already done so).
+2. [Clone](https://help.github.com/articles/cloning-a-repository/) it to your computer.
+3. When you're ready to work on an issue, be sure you're on the master branch. From there, [create a separate branch](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches) (e.g. issue_32).
+4. Make your changes. If you're unsure of some details while you're making edits, you can discuss them on the ticket or in Slack.
+5. Commit your changes.
+6. Push the working branch (e.g. issue_32) to your remote fork.
+7. Make the pull request (on the [upstream master branch](https://github.com/julianguyen/ifme/tree/master))
+  - Do not merge it with the master branch on your fork. That would result in multiple, or unrelated patches being included in a single PR.
+8. If any further changes need to be made, comments will be made on the pull request.
+
+It's possible to work on two or more different patches (and therefore multiple branches) at one time, but it's recommended that beginners only work on one patch at a time.
+
+#### Syncing
+
+Periodically, you'll need to sync your repo with mine (the upstream). GitHub has instructions for doing this.
+
+1. [Configuring a remote for a fork](https://help.github.com/articles/configuring-a-remote-for-a-fork/)
+  - For step 3 on that page, use https://github.com/julianguyen/ifme.git for the URL.
+2. [Syncing a Fork](https://help.github.com/articles/syncing-a-fork/)
+On that page, it shows how to merge the master branch (steps 4 & 5).
+3. When your patch is completed, do not merge your patch into the master branch of your locally cloned fork. Your patch will be merged when you sync with the remote fork.
+
 If you've been added as a collaborator to the repository, please do not push
 unless the commit you are making is _trivial_ i.e. doesn't require a code
 review. If you're unsure about this, please ask!
@@ -82,7 +106,7 @@ comments and `rake db:drop db:create db:migrate; rake db:schema:load` to update
 
 * We follow airbnb's Ruby and Javascript Style Guides.
 The guides are available on GitHub in the following repositories:
-https://github.com/airbnb/ruby and 
+https://github.com/airbnb/ruby and
 https://github.com/airbnb/javascript
 
 ## Tracking Issues