Skip to content

Commit e4ab94a

Browse files
committed
docs: update CONTRIBUTING.md
1 parent 504f851 commit e4ab94a

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
1-
# Scope
1+
# Contributing to jupyterlab-deepnote
2+
3+
Thank you for your interest in contributing to the Deepnote JupyterLab extension! This guide will help you set up your development environment and understand the contribution workflow.
24

35
This document is intended for contributors and maintainers working on the extension's source code. For general usage and installation instructions, please refer to the README.
46

57
# Contributing to `jupyterlab-deepnote`
68

9+
## Prerequisites
10+
11+
Before you begin, ensure you have the following installed:
12+
13+
1. [Python](https://www.python.org/) 3.10 or later - Required for the server extension
14+
2. [Node.js](https://nodejs.org/) v22 or later - Required for building the frontend extension
15+
3. [JupyterLab](https://jupyterlab.readthedocs.io/) >= 4.4.0 - The extension requires JupyterLab 4.x
16+
4. **GitHub Account** - With access to create [Personal Access Tokens](https://github.com/settings/tokens)
17+
718
## Development install
819

920
Note: You will need NodeJS to build the extension package.
@@ -182,3 +193,19 @@ This will apply the latest template changes interactively. Review and commit any
182193
## Release workflow
183194

184195
See [RELEASE](RELEASE.md) for details on the release process. We recommend using [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser) and [PyPI trusted publishing](https://docs.pypi.org/trusted-publishers/) for secure and automated releases.
196+
197+
## Additional Resources
198+
199+
- [JupyterLab Extension Developer Guide](https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html)
200+
- [JupyterLab Extension Tutorial](https://jupyterlab.readthedocs.io/en/stable/extension/extension_tutorial.html)
201+
- [Project Issues](https://github.com/deepnote/jupyterlab-deepnote/issues)
202+
203+
## Questions?
204+
205+
If you have questions or run into issues:
206+
207+
1. Check the [Troubleshooting](#troubleshooting) section above
208+
2. Search existing [GitHub Issues](https://github.com/deepnote/jupyterlab-deepnote/issues)
209+
3. Open a new issue with details about your problem
210+
211+
Thank you for contributing! 🎉

0 commit comments

Comments
 (0)