[#34] Updated documentation and added CONTRIBUTING.md (#39)

paypal · Aug 27, 2018 · 58febf4 · 58febf4
1 parent 7c746ce
commit 58febf4
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 9 deletions.
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -0,0 +1,45 @@
+                                   
+# Contributing to PPExtensions
+
+## Discussions
+
+Our recommendation is to start a slack discussion as soon as you have an idea for contributing to PPExtensions.
+This will help you, other interested contributors & the committers get to common grounds early in time.
+Contact the PPExtenions community on [slack](https://join.slack.com/t/ppextensions/shared_invite/enQtNDIyODk5NzYzMzEyLTIwOGM3MWE0OGZlNjFkYTUxZTJiN2NjOWFlNmUxNDRiY2U3MzE0Nzg5NDRjZjE2M2VmZGI4NWJhOGVjYTRiMTk).
+
+--------------------------------------------------------------------------------------------------------------------
+
+## How can you help
+
+### Code
+Look for Issues that are open on below categories, pick an issue, start a slack discussion on slack channel, once we get to common grounds on the solution approach, open a PR with your implementation.
+* Bug Fixes
+* Enhancements & Improvements (Jira Details)
+* Add a new extension that you see are useful to Jupyter community
+
+### Documentation
+You can also improve our documentation
+* readme.md
+* docs/*.md
+* Any other valuable comment you'd like to add to the code that will simplify other developers' lives.
+
+--------------------------------------------------------------------------------------------------------------------
+
+
+## Contribution Process
+
+* Get your github account.
+* Fork the PPExtensions repo into your account.
+* Create an issue branch using the master branch.
+* Make modifications to the code.
+* Ensure code coverage by added test cases.
+* All commits must have the issue ID & summary. Say "[#32] Add Codacy Integration and Badge".
+* Ensure all your commits are squashed.
+* Make a Pull Request to develop branch.
+* If there are code review related changes - ensure those commits are also squashed.
+* DO NOT include changes that are not directly related to the issue you are trying to resolve.
+* Once PR is approved, code will be merged to Development branch.
+* Once all regression test cases have passed - changes will be merged to master branch.
+
+--------------------------------------------------------------------------------------------------------------------
+
diff --git a/docs/getting-started/build-ppextensions.md b/docs/getting-started/build-ppextensions.md
@@ -1,15 +1,16 @@
 ## Install 
-```buildoutcfg
+```
 pip install ppextensions
 ```
+
 ## Try ppextensions
 ```
 %load_ext ppextensions.ppmagics
 ```
 
 Try help to see all the available options
-```buildoutcfg
-%%help?
+```
+%help
 ```
 
 | Magic               | Usage          | Explanation                                                                                                                    |
@@ -24,4 +25,4 @@ Try help to see all the available options
 
 
 For more info:
-[Github Link](git@github.com:paypal/PPExtensions.git)
+[Github Link](https://github.com/paypal/PPExtensions/)
diff --git a/docs/index.md b/docs/index.md
@@ -5,10 +5,10 @@ PPExtensions is a suite of ipython and jupyter extensions built to improve user
 
 # Features
 
-- **PPMagics** - Set of magics to simplify access to different storage systems and tableau.
-- **Github Integration** - A jupyter extension to integrate notebooks with github. This extension simplifies version controlling, sharing and resolving merge conflicts of notebooks.
-- **Notebooks Scheduling** - A jupyter extension to productionalize the notebooks development environment. This extension enables scheduling notebooks with help of [airflow](https://airflow.apache.org/).
-- **Config UI** - A simple UI built to change the configurations of different extensions like PPMagic, [sparkmagic](https://github.com/jupyter-incubator/sparkmagic) ..etc.
+- **[PPMagics](ppmagics/csv.md)** - Set of magics to simplify access to different storage systems and tableau.
+- **[Github Integration](ppextensions-github-integration/github-integration.md)** - A jupyter extension to integrate notebooks with github. This extension simplifies version controlling, sharing and resolving merge conflicts of notebooks.
+- **[Notebooks Scheduling](ppextensions-scheduler/scheduler.md)** - A jupyter extension to productionalize the notebooks development environment. This extension enables scheduling notebooks with help of [airflow](https://airflow.apache.org/).
+- **[Config UI](ppextensions-config-ui/config-ui.md)** - A simple UI built to change the configurations of different extensions like PPMagic, [sparkmagic](https://github.com/jupyter-incubator/sparkmagic) ..etc.
 
 
 # Installation
@@ -33,6 +33,6 @@ PPExtensions is a suite of ipython and jupyter extensions built to improve user
 
 # Questions
 
-* [Slack](https://ppextensions.slack.com)
+* [Slack](https://join.slack.com/t/ppextensions/shared_invite/enQtNDIyODk5NzYzMzEyLTIwOGM3MWE0OGZlNjFkYTUxZTJiN2NjOWFlNmUxNDRiY2U3MzE0Nzg5NDRjZjE2M2VmZGI4NWJhOGVjYTRiMTk)
 * [User Forum](https://groups.google.com/d/forum/ppextensions)
 * [Developer Forum](https://groups.google.com/d/forum/ppextensions)
diff --git a/docs/ppextensions-config-ui/config-ui.md b/docs/ppextensions-config-ui/config-ui.md
@@ -0,0 +1,3 @@
+## Config UI
+
+Coming Soon