Merge pull request plotly#986 from plotly/contributing-doc-update

priyatharsan · web-flow · commit d01be87ed14b · 2018-07-27T14:51:50.000-04:00
Contributing doc update
diff --git a/Contributing.md b/Contributing.md
@@ -1,15 +1,15 @@
 ## Repo Organization
 Edit or add files in the `_posts` folder in the [source-design-merge](http://github.com/plotly/documentation/tree/source-design-merge) branch.
 
-## Clone the Repo and Install Dependencies 
+## Clone the Repo and Install Dependencies
 1. Clone the repo and then check out the source-design-merge branch:
 
   ```
   $ git clone git@github.com:plotly/documentation.git
   $ git fetch origin
   $ git checkout source-design-merge
   ```
- 
+
 2. Check Ruby version `$ ruby --version`. We recommend using the same ruby version as gh-pages: https://pages.github.com/versions/. Note [RVM](https://rvm.io/rvm/install) is helpful for installing and managing ruby versions.
 
 3. Install bundler and dependencies from the `gemfile`:
@@ -23,7 +23,7 @@ Note these dependencies should be the same version that gh-pages is using: https
 4. When we deploy, a function is run to update the plot schema. To do this successfully you have to make sure you have the `requests` python package: `pip install requests`
 
 ## Making Changes
-- For information about editing **plotly.js** docs see: https://github.com/plotly/documentation/blob/source-design-merge/_posts/plotly_js/README.md 
+- For information about editing **plotly.js** docs see: https://github.com/plotly/documentation/blob/source-design-merge/_posts/plotly_js/README.md
 - For information about editing **python** docs see: https://github.com/plotly/documentation/blob/source-design-merge/_posts/python/README.md
 - For information about editing **R** docs see: https://github.com/plotly/documentation/blob/source-design-merge/_posts/r/README.md
 - For information about editing chart studio documentation found at [https://help.plot.ly/tutorials/](https://help.plot.ly/tutorials/) please see this repo: [https://github.com/plotly/plotly.github.io](https://github.com/plotly/plotly.github.io)
@@ -57,8 +57,10 @@ exclude: []
 and it'll load everything.
 
 ## Make a PR
-Ready for your changes to be reviewed? Make a pull request against the `source-design-merge` branch! 
+Ready for your changes to be reviewed? Make a pull request against the `source-design-merge` branch!
 Create a feature branch and use `git status` to list changed files.
+
+(Make sure that the feature branch is a branch off from `source-design-merge` local branch in your machine and not from any other previously worked branch).
 ```
 git checkout -b your_feature_branch
 git status
@@ -90,7 +92,7 @@ documentation (source-design-merge) $ bundle exec rake deploy
 
 ## Search
 
-We now have search via algolia implemented on our index and reference documentation pages! Please refer to our [make README](https://github.com/plotly/documentation/blob/source-design-merge/make_instructions.txt) for more information on how search works and instructions on how to update or edit Plotly search indices. 
+We now have search via algolia implemented on our index and reference documentation pages! Please refer to our [make README](https://github.com/plotly/documentation/blob/source-design-merge/make_instructions.txt) for more information on how search works and instructions on how to update or edit Plotly search indices.
 
 ## Style Edits
 
