Skip to content

Commit

Permalink
add contributing instructions
Browse files Browse the repository at this point in the history
Sheila-nk committed Apr 10, 2023
1 parent 97e7e02 commit 9f8fe41
Showing 2 changed files with 14 additions and 1 deletion.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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/).
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 9f8fe41

Please sign in to comment.