Skip to content

Commit 4066e83

Browse files
benelotconsideRatio
authored andcommitted
CONTRIBUTION.md created from Wiki entry
1 parent fabc047 commit 4066e83

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
**Hello and welcome to the contribution page of jupyter notebook nbextensions!**
2+
3+
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.
4+
5+
### Create an issue
6+
7+
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.
8+
9+
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)
10+
11+
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.
12+
13+
### Create a pull request
14+
Then, as you are ready with your contribution, pull-request to the main repo and explain quickly what you have done.
15+
16+
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)
17+
18+
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.

0 commit comments

Comments
 (0)