Help on setting up development added

Author: consideRatio

CHANGELOG.md

@@ -47,6 +47,9 @@ Repo-level stuff:
    [#1200](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/pull/1200),
    [#1201](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/pull/1201)
    [@jcb91](https://github.com/jcb91)
+- Added CONTRIBUTION.md
+   [#1224](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/pull/1224)
+   [@consideratio](https://github.com/consideratio)
 
 New features and bugfixes:
 

CONTRIBUTING.md

@@ -1,18 +1,38 @@
-**Hello and welcome to the contribution page of jupyter notebook nbextensions!**
+# Contributing to jupyter notebook nbextensions
 
-We are super happy that you intend to contribute to the nbextensions. Here is the plan how this works very nicely, for you and of course for the repository maintainer too.
+We are super happy that you intend to contribute to the nbextensions! You can discuss improvements in issues and improvement them in pull requests.
 
-### Create an issue
+## Create an issue
 
-Do not hesitate to open up an issue to propose your new extension and how you would think of it to work. Like that, it is easier to point you to extensions that do similar things, whether it is worth it to implement this, what to look for etc.
+Do not hesitate to open up an issue, you can discuss bugs, improvements or new extensions in them. Creating an issue is a good starting point for code contributions. The community can support you with experience of similar extensions, pros and cons, what to look for etc.
 
-Here is an example issue of how @benelot did it and it worked pretty smoothly: [#1193](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/issues/1193)
+Here is an example issue of how @benelot did it that worked pretty smoothly: [#1193](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/issues/1193)
 
-To create a new jupyter notebook extension, just fork the repository and clone it to your local machine. Then look into the [jupyter_contrib_nbextensions/nbextensions](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/tree/master/src/jupyter_contrib_nbextensions/nbextensions) folder and add a folder with the name of your new extension. Check out the [Jupyter Notebook extension structure Link](http://jupyter-contrib-nbextensions.readthedocs.io/en/latest/internals.html)k to know what else has to be in that folder and what are the general conventions for it.
+## Setup development
 
-### Create a pull request
-Then, as you are ready with your contribution, pull-request to the main repo and explain quickly what you have done.
+1. __Fork and clone__
+First fork this repo, then clone your fork. In this way you become prepared to make a pull request.
 
-Here is an example pull request of how @benelot did it and it worked super well: [#1213](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/pull/1213)
+```shell
+# clone your fork
+git clone https://github.com/<your-github-username>/jupyter_contrib_nbextensions.git
+cd jupyter_contrib_nbextensions
+```
+2. __Setup__
+```shell
+# run from the main directory, where setup.py is
+pip install --editable .
+jupyter-contrib-nbextension install --symlink --sys-prefix
+```
 
-Do not forget to add your new extension to the [CHANGELOG.md](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/blob/master/CHANGELOG.md) so that it will be announced to be in the release.
+## Create an extension
+
+Add a folder with the name of your new extension to [jupyter_contrib_nbextensions/nbextensions](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/tree/master/src/jupyter_contrib_nbextensions/nbextensions). Check out the [Jupyter Notebook extension structure link](http://jupyter-contrib-nbextensions.readthedocs.io/en/latest/internals.html) to know what has to be in that folder and what the general conventions are.
+
+## Create a pull request
+
+As you are ready with your code contribution, make a pull-request to the main repo and briefly explain what you have done.
+
+Here is an example pull request of how @benelot did it that worked super well: [#1213](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/pull/1213)
+
+Please also update the [CHANGELOG.md](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/blob/master/CHANGELOG.md).

README.md

@@ -246,16 +246,7 @@ For further details, see [the documentation at jupyter-contrib-nbextensions.read
 Contributing
 ============
 
-1. __Fork__
-2. __Clone and setup__
-```bash
-git clone https://github.com/ipython-contrib/jupyter_contrib_nbextensions.git
-cd jupyter_contrib_nbextensions
-pip install --editable .
-jupyter-contrib-nbextension install --symlink --sys-prefix
-```
-3. __Develop__
-4. __Pull request__
+To learn how to setup a development enivornment and contribution guidelines, see [CONTRIBUTING.md](./CONTRIBUTING.md).
 
 Changes
 =======