Skip to content

docs: update CONTRIBUTING.md #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 31, 2025
Merged

docs: update CONTRIBUTING.md #67

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e4ab94a
docs: update CONTRIBUTING.md
dinohamzic Oct 31, 2025
2862c4b
docs: remove duplicate title
dinohamzic Oct 31, 2025
3d6873d
docs: bump minimum version
dinohamzic Oct 31, 2025
b207ac2
documentation: making changes section
dinohamzic Oct 31, 2025
52bb45e
docs: update questions section
dinohamzic Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# Scope
# Contributing to `jupyterlab-deepnote`

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.

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.

# Contributing to `jupyterlab-deepnote`
## Prerequisites

Before you begin, ensure you have the following installed:

1. [Python](https://www.python.org/) 3.10 or later - Required for the server extension
2. [Node.js](https://nodejs.org/) v22 or later - Required for building the frontend extension
3. [JupyterLab](https://jupyterlab.readthedocs.io/) >= 4.4.0 - The extension requires JupyterLab 4.x
4. **GitHub Account** - With access to create [Personal Access Tokens](https://github.com/settings/tokens)

## Development install

Expand Down Expand Up @@ -182,3 +191,19 @@ This will apply the latest template changes interactively. Review and commit any
## Release workflow

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.

## Additional Resources

- [JupyterLab Extension Developer Guide](https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html)
- [JupyterLab Extension Tutorial](https://jupyterlab.readthedocs.io/en/stable/extension/extension_tutorial.html)
- [Project Issues](https://github.com/deepnote/jupyterlab-deepnote/issues)

## Questions?

If you have questions or run into issues:

1. Check the [Troubleshooting](#troubleshooting) section above
2. Search existing [GitHub Issues](https://github.com/deepnote/jupyterlab-deepnote/issues)
3. Open a new issue with details about your problem

Thank you for contributing! 🎉
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Deepnote is the data notebook for the AI era. `jupyterlab-deepnote` is a Jupyter
### Requirements

- **Python**: 3.10 or higher
- **JupyterLab**: 4.0.0 or higher
- **JupyterLab**: 4.4.0 or higher

### Install via pip

Expand Down