mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-18 23:42:59 +00:00
81 lines
1.6 KiB
Markdown
81 lines
1.6 KiB
Markdown
# Contributing
|
|
|
|
We want you to contribute to JupyterHub in ways that are most exciting
|
|
and useful to you. We value documentation, testing, bug reporting & code equally,
|
|
and are glad to have your contributions in whatever form you wish.
|
|
|
|
Be sure to first check our [Code of Conduct](https://github.com/jupyter/governance/blob/HEAD/conduct/code_of_conduct.md)
|
|
([reporting guidelines](https://github.com/jupyter/governance/blob/HEAD/conduct/reporting_online.md)), which help keep our community welcoming to as many people as possible.
|
|
|
|
This section covers information about our community, as well as ways that you can connect and get involved.
|
|
|
|
## Contributors
|
|
|
|
Here are the people who keep JupyterHub running and updated.
|
|
|
|
```{toctree}
|
|
:maxdepth: 1
|
|
|
|
contributor-list
|
|
```
|
|
|
|
## Communication channels
|
|
|
|
Learn about the different communication channels used by the JupyterHub community.
|
|
|
|
```{toctree}
|
|
:maxdepth: 2
|
|
|
|
community
|
|
```
|
|
|
|
## Set up a local development environment
|
|
|
|
This section covers how to clone the JupyterHub Github repository and install a local copy.
|
|
|
|
```{toctree}
|
|
:maxdepth: 2
|
|
|
|
setup
|
|
```
|
|
|
|
## Contribute to the documentation
|
|
|
|
Have a local development install ready? You can build JupyterHub's docs locally as well.
|
|
|
|
```{toctree}
|
|
:maxdepth: 2
|
|
|
|
docs
|
|
```
|
|
|
|
## Testing JupyterHub
|
|
|
|
Run tests in your local JupyterHub development install.
|
|
|
|
```{toctree}
|
|
:maxdepth: 2
|
|
|
|
tests
|
|
```
|
|
|
|
## JupyterHub roadmap
|
|
|
|
Which way, JupyterHub? Find out in the roadmap.
|
|
|
|
```{toctree}
|
|
:maxdepth: 2
|
|
|
|
roadmap
|
|
```
|
|
|
|
## Reporting security issues
|
|
|
|
Found a bug or vulnerability? Report to JupyterHub's maintainers.
|
|
|
|
```{toctree}
|
|
:maxdepth: 1
|
|
|
|
security
|
|
```
|