From e4ab94a918a6a35101af2779757ae2ad9725ff6c Mon Sep 17 00:00:00 2001 From: dinohamzic Date: Fri, 31 Oct 2025 13:55:35 +0100 Subject: [PATCH 1/5] docs: update CONTRIBUTING.md --- CONTRIBUTING.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5d6a395..78b21fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,20 @@ -# 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 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 ## 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! 🎉 From 2862c4b2b230a75e270775af8a7b35bed7f89194 Mon Sep 17 00:00:00 2001 From: dinohamzic Date: Fri, 31 Oct 2025 13:58:00 +0100 Subject: [PATCH 2/5] docs: remove duplicate title --- CONTRIBUTING.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 78b21fd..0715231 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,9 @@ -# Contributing to jupyterlab-deepnote +# 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: From 3d6873dc2b08603e976ef0306bd9a38dbef77442 Mon Sep 17 00:00:00 2001 From: dinohamzic Date: Fri, 31 Oct 2025 13:59:07 +0100 Subject: [PATCH 3/5] docs: bump minimum version --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 54f7419..fa00a1a 100644 --- a/README.md +++ b/README.md @@ -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 From b207ac217e4fbf4627d46d52d31e2b40e8681015 Mon Sep 17 00:00:00 2001 From: dinohamzic Date: Fri, 31 Oct 2025 14:15:30 +0100 Subject: [PATCH 4/5] documentation: making changes section --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0715231..3343f03 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -188,6 +188,24 @@ copier update --trust This will apply the latest template changes interactively. Review and commit any updates as appropriate. +## Making Changes + +### Code Style + +- **Python:** Follow PEP 8 guidelines +- **TypeScript:** The project uses ESLint and Prettier (configured in the project) + +### Pull Requests + +1. Fork the repository +2. Create a feature branch (`git checkout -b feature/amazing-feature`) +3. Make your changes +4. Write clear, descriptive commit messages +5. Run tests to ensure everything passes +6. Commit your changes +7. Push to your fork +8. Open a Pull Request with a clear description + ## 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. From 52bb45e8bc01ee529c74595c9abcb987b3dc9f0b Mon Sep 17 00:00:00 2001 From: dinohamzic Date: Fri, 31 Oct 2025 14:17:22 +0100 Subject: [PATCH 5/5] docs: update questions section --- CONTRIBUTING.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3343f03..c6f685d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -220,8 +220,7 @@ See [RELEASE](RELEASE.md) for details on the release process. We recommend using 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 +1. Search existing [GitHub Issues](https://github.com/deepnote/jupyterlab-deepnote/issues) +2. Open a new issue with details about your problem Thank you for contributing! 🎉