Skip to content

Updating Documentation for Contributing steps #25

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 2 commits into from
Oct 24, 2025
Merged

Updating Documentation for Contributing steps #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9335d0d
Updating Documentation for Contributing steps
nakul-py Oct 23, 2025
9a68794
lint fix
nakul-py Oct 23, 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
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Contributing
# Contributing

### Development install
## Development install

Note: You will need NodeJS to build the extension package.

Expand Down Expand Up @@ -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
Expand Down
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://github.com/user-attachments/assets/0dacd7f0-5963-4ebe-81da-2958f0117071>

### Programmatic Usage

Expand Down Expand Up @@ -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
```

Expand Down Expand Up @@ -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:
Expand Down
Loading