From 9335d0d42db70a4a907c56eb7e5f721e149c0cb5 Mon Sep 17 00:00:00 2001 From: Nakul Date: Thu, 23 Oct 2025 21:00:58 +0530 Subject: [PATCH 1/2] Updating Documentation for Contributing steps --- CONTRIBUTING.md | 6 +++--- README.md | 15 +++++++++++++-- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 33e5dec..aad7d39 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -## Contributing +# Contributing -### Development install +## Development install Note: You will need NodeJS to build the extension package. @@ -36,7 +36,7 @@ By default, the `jlpm build` command generates the source maps for this extensio jupyter lab build --minimize=False ``` -### Development uninstall +## Development uninstall ```bash # Server extension must be manually disabled in develop mode diff --git a/README.md b/README.md index 975d931..96e869d 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ The extension provides commands to show diffs in multiple formats: - `jupyterlab-diff:unified-cell-diff` - Show cell diff using unified view - `jupyterlab-diff:unified-file-diff` - Show file diff using unified view for regular Python files and other text files -https://github.com/user-attachments/assets/0dacd7f0-5963-4ebe-81da-2958f0117071 + ### Programmatic Usage @@ -82,7 +82,7 @@ The commands can also be run from the browser console (for example during develo First JupyterLab needs to be started with the `--expose-app-in-browser` flag to expose `window.jupyterapp`: -``` +```bash jupyter lab --expose-app-in-browser ``` @@ -138,6 +138,17 @@ The extension provides two diff viewing strategies: - **Unified diff** (`unified-cell-diff`/`unified-file-diff`): Uses CodeMirror's `unifiedMergeView`. Displays changes in a single unified view with added/removed lines clearly marked. Can be used for both cell diffs and regular file diffs. +## Contributing + +We welcome contributions from the community! To contribute: + +- Fork the repository +- Make a development install of jupyterlab-diff +- Create a new branch +- Make your changes +- Submit a pull request +For more details, check out our [CONTRIBUTING.md](https://github.com/jupyter-ai-contrib/jupyterlab-diff?tab=contributing-ov-file#contributing). + ## Uninstall To remove the extension, execute: From 9a68794a62a7779fa8e976dbaa0a30caa3281d41 Mon Sep 17 00:00:00 2001 From: Nakul Date: Thu, 23 Oct 2025 21:29:50 +0530 Subject: [PATCH 2/2] lint fix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 96e869d..813f8f2 100644 --- a/README.md +++ b/README.md @@ -147,7 +147,7 @@ We welcome contributions from the community! To contribute: - Create a new branch - Make your changes - Submit a pull request -For more details, check out our [CONTRIBUTING.md](https://github.com/jupyter-ai-contrib/jupyterlab-diff?tab=contributing-ov-file#contributing). + For more details, check out our [CONTRIBUTING.md](https://github.com/jupyter-ai-contrib/jupyterlab-diff?tab=contributing-ov-file#contributing). ## Uninstall