Skip to content

Commit ef82139

Browse files
authored
docs: update CONTRIBUTING.md (#67)
1 parent 504f851 commit ef82139

File tree

2 files changed

+45
-3
lines changed

2 files changed

+45
-3
lines changed

CONTRIBUTING.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
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

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

716
## Development install
817

@@ -179,6 +188,39 @@ copier update --trust
179188

180189
This will apply the latest template changes interactively. Review and commit any updates as appropriate.
181190

191+
## Making Changes
192+
193+
### Code Style
194+
195+
- **Python:** Follow PEP 8 guidelines
196+
- **TypeScript:** The project uses ESLint and Prettier (configured in the project)
197+
198+
### Pull Requests
199+
200+
1. Fork the repository
201+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
202+
3. Make your changes
203+
4. Write clear, descriptive commit messages
204+
5. Run tests to ensure everything passes
205+
6. Commit your changes
206+
7. Push to your fork
207+
8. Open a Pull Request with a clear description
208+
182209
## Release workflow
183210

184211
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.
212+
213+
## Additional Resources
214+
215+
- [JupyterLab Extension Developer Guide](https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html)
216+
- [JupyterLab Extension Tutorial](https://jupyterlab.readthedocs.io/en/stable/extension/extension_tutorial.html)
217+
- [Project Issues](https://github.com/deepnote/jupyterlab-deepnote/issues)
218+
219+
## Questions?
220+
221+
If you have questions or run into issues:
222+
223+
1. Search existing [GitHub Issues](https://github.com/deepnote/jupyterlab-deepnote/issues)
224+
2. Open a new issue with details about your problem
225+
226+
Thank you for contributing! 🎉

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Deepnote is the data notebook for the AI era. `jupyterlab-deepnote` is a Jupyter
3333
### Requirements
3434

3535
- **Python**: 3.10 or higher
36-
- **JupyterLab**: 4.0.0 or higher
36+
- **JupyterLab**: 4.4.0 or higher
3737

3838
### Install via pip
3939

0 commit comments

Comments
 (0)