Skip to content
This repository was archived by the owner on Mar 26, 2019. It is now read-only.

Commit 051656d

Browse files
authored
Create new file
Added a contributing md file as a place holder for first time contribution prior to the pydata nyc sprints.
1 parent 3d83e82 commit 051656d

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

CONTRIBUTING.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Contributing to Project Jupyter for the First Time
2+
3+
Welcome fellow contributor! We appreciate your help.
4+
5+
We typically label issues appropriate for new contributors as `good first issue` or `help wanted`. To start an issue, you may comment to let everyone know that you'll be working on it. Our repos provide developer installation instructions in each repo's `CONTRIBUTING.md`. **Should you find an issue with our developer installation instructions please let us know in our issues.** We want to ensure that our documentation for developer installation is accurate. Additionally, other contributors are often available to answer questions about fixing the issue on the issue number or on the repo's gitter channel.
6+
7+
We strive to have a inclusive, welcoming community. Please read our [code of conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md) to learn more.
8+
9+
## Major Repos and Issue Types
10+
11+
### Python
12+
13+
IPython, JupyterHub, and Binder are major repos written primarily in Python.
14+
15+
* [iPython](https://github.com/ipython/ipython)
16+
- [Notable Issues](https://github.com/ipython/ipython/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
17+
- [Gitter Channel](https://gitter.im/ipython/ipython)
18+
19+
* [JupyterHub](https://github.com/jupyterhub/jupyterhub)
20+
- [Notable Issues](https://github.com/jupyterhub/jupyterhub/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
21+
- [Gitter Channel](https://gitter.im/jupyterhub/jupyterhub)
22+
23+
* [Binder](https://github.com/jupyterhub/binderhub)
24+
- [Notable Issues](https://github.com/jupyterhub/binderhub/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
25+
- [Gitter Channel](https://gitter.im/jupyterhub/binder)
26+
27+
### Documentation
28+
29+
All our repos have documentation issues that are relevant for new contributors.
30+
31+
### JavaScript/TypeScript
32+
33+
Jupyter Notebook, JupyterLab, and IPyWidgets use JavaScript and TypeScript.
34+
35+
* [Jupyter Notebook](https://github.com/jupyter/notebook)
36+
- [Sprint-friendly Issues](https://github.com/jupyter/notebook/issues?q=is%3Aissue+is%3Aopen+label%3A%22tag%3ANew+Contributor%22)
37+
- [Gitter Channel](https://gitter.im/jupyter/notebook)
38+
39+
* [JupyterLab](https://github.com/jupyterlab/jupyterlab)
40+
- [Sprint-friendly Issues](https://github.com/jupyterlab/jupyterlab/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3AHelp+Wanted%22)
41+
- [Gitter Channel](https://gitter.im/jupyterlab/jupyterlab)
42+
43+
* [iPyWidgets](https://github.com/jupyter-widgets/ipywidgets)
44+
- [Sprint-friendly Issues](https://github.com/jupyter-widgets/ipywidgets/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
45+
- [Gitter Channel](https://gitter.im/jupyter-widgets/Lobby)
46+
47+
### DevOps
48+
49+
JupyterHub and Binder have many issues related to devops. See links above.
50+
51+
### Web Development
52+
53+
We have issues related to the website.
54+
55+
* [Project Jupyter's Website](https://github.com/jupyter/jupyter.github.io/)
56+
- [Sprint-friendly Issues](https://github.com/jupyter/jupyter.github.io/issues?q=is%3Aissue+is%3Aopen+label%3Asprint-friendly)
57+
58+
59+
## Contributor Guide
60+
61+
For more information, please read our [Contributor Guide](https://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html)
62+

0 commit comments

Comments
 (0)