Merge pull request #1225 from consideRatio/readme-pr

FIXES #1224 - Added contribution section to README.md

Author: jcb91

CHANGELOG.md

@@ -21,6 +21,16 @@ Unreleased (aka. GitHub master)
 This is where each new PR to the project should add a summary of its changes,
 which makes it much easier to fill in each release's changelog :)
 
+Repo-level stuff:
+
+- Added CONTRIBUTING.md
+   [#1224](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/pull/1224)
+   [@consideratio](https://github.com/consideratio)
+
+New features and bugfixes:
+
+ - `init_cell`
+   * Warning dialog now always relevant, fixes [#1223](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/issues/1223). [#1226](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/pull/1226) [@consideratio](https://github.com/consideratio)
 
 0.4.0
 -----
@@ -118,10 +128,6 @@ New features and bugfixes:
  - `code_prettify` Update `code_prettify.yaml`
    [#1162](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/pull/1162)
    [@fehiepsi](https://github.com/fehiepsi)
- - `init_cell`
-   * Warning dialog now always relevant, fixes [#1223].(https://github.com/ipython-contrib/jupyter_contrib_nbextensions/issues/1223)
-     [#1226](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/pull/1226)
-     [@consideratio](https://github.com/consideratio)
 
 
 0.3.3

CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# Contributing to jupyter notebook nbextensions
+
+We are super happy that you intend to contribute to the nbextensions! You can discuss improvements in issues and implement them in pull requests.
+
+## Create an issue
+
+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 that worked pretty smoothly: [#1193](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/issues/1193)
+
+## Setup development
+
+For small things like fixing typos in documentation, you can [make edits through GitHub](https://help.github.com/articles/editing-files-in-another-user-s-repository/), which will handle forking and making a pull request (PR) for you. For anything bigger or more complex, you'll probably want to set up a development environment, a quick procedure for which is as folows:
+
+1. __Fork and clone__
+   First fork this repo, then clone your fork. In this way you become prepared to make a pull request.
+
+   ```shell
+   # clone your fork
+   git clone https://github.com/<your-github-username>/jupyter_contrib_nbextensions.git
+   cd jupyter_contrib_nbextensions
+   ```
+
+2. __Setup__
+
+   If you're using python in combination with some form of virtual environment (e.g. conda, virtualenv), make sure you have the correct environment (the one from which you run `jupyter notebook`) active before running these commands!
+
+   ```shell
+   # run from the main directory, where setup.py is
+   pip install --editable .
+
+   # on windows, remove the --symlink flag and re-run the command each time you make changes
+   jupyter-contrib-nbextension install --sys-prefix --symlink
+   ```
+
+## 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 [unreleased section](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/blob/master/CHANGELOG.md#unreleased-aka-github-master) of the [CHANGELOG.md](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/blob/master/CHANGELOG.md) to note what you've added or fixed.

MANIFEST.in

@@ -1,6 +1,7 @@
 # explicit includes
 include COPYING.rst
 include README.md
+include CONTRIBUTING.md
 include CHANGELOG.md
 include tox.ini
 include .bumpversion.cfg

README.md

@@ -243,6 +243,11 @@ Each notebook extension typically has its own directory named after the extensio
 
 For further details, see [the documentation at jupyter-contrib-nbextensions.readthedocs.io](http://jupyter-contrib-nbextensions.readthedocs.io/en/latest/internals.html).
 
+Contributing
+============
+
+To learn how to setup a development enivornment and contribution guidelines, see [CONTRIBUTING.md](./CONTRIBUTING.md).
+
 Changes
 =======