diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cef2cb3..8ebb69b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,4 +6,10 @@ you can follow the [Jupyter contributor guide](https://jupyter.readthedocs.io/en Make sure to also follow [Project Jupyter's Code of Conduct](https://github.com/jupyter/governance/blob/HEAD/conduct/code_of_conduct.md) for a friendly and welcoming collaborative environment. +Please see our documentation on: + +- [Setting up a development install](https://pytest-jupyterhub.readthedocs.io/en/latest/contributing/setup.html) +- [Testing Pytest JupyterHub](https://pytest-jupyterhub.readthedocs.io/en/latest/contributing/tests.html) +- [Contributing Documentation](https://pytest-jupyterhub.readthedocs.io/en/latest/contributing/docs.html) + If you need some help, feel free to ask on [Gitter](https://gitter.im/jupyterhub/jupyterhub) or [Discourse](https://discourse.jupyter.org/). diff --git a/README.md b/README.md index 9e24d8c..a104213 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ **[Description](#description)** | **[Installation](#installation)** | -**[Usage](#usage)** +**[Usage](#usage)** | +**[Contributing](#contributing)** --- @@ -78,3 +79,9 @@ async def app(hub_app): return app ``` + +## Contributing + +If you would like to contribute to the project, please read our [contributor documentation](https://pytest-jupyterhub.readthedocs.io/en/latest/contributing/index.html) and the [CONTRIBUTING.md](https://github.com/jupyterhub/pytest-jupyterhub/blob/main/CONTRIBUTING.md). + +The contributor documentation explains how to set up a development installation, how to run the test suite, and how to contribute to documentation.