Skip to content

Commit d9dcd67

Browse files
authored
Updating Documentation for Contributing steps (jupyter-ai-contrib#25)
* Updating Documentation for Contributing steps * lint fix
1 parent a6cab6d commit d9dcd67

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Contributing
1+
# Contributing
22

3-
### Development install
3+
## Development install
44

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

@@ -36,7 +36,7 @@ By default, the `jlpm build` command generates the source maps for this extensio
3636
jupyter lab build --minimize=False
3737
```
3838

39-
### Development uninstall
39+
## Development uninstall
4040

4141
```bash
4242
# Server extension must be manually disabled in develop mode

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The extension provides commands to show diffs in multiple formats:
3838
- `jupyterlab-diff:unified-cell-diff` - Show cell diff using unified view
3939
- `jupyterlab-diff:unified-file-diff` - Show file diff using unified view for regular Python files and other text files
4040

41-
https://github.com/user-attachments/assets/0dacd7f0-5963-4ebe-81da-2958f0117071
41+
<https://github.com/user-attachments/assets/0dacd7f0-5963-4ebe-81da-2958f0117071>
4242

4343
### Programmatic Usage
4444

@@ -82,7 +82,7 @@ The commands can also be run from the browser console (for example during develo
8282

8383
First JupyterLab needs to be started with the `--expose-app-in-browser` flag to expose `window.jupyterapp`:
8484

85-
```
85+
```bash
8686
jupyter lab --expose-app-in-browser
8787
```
8888

@@ -138,6 +138,17 @@ The extension provides two diff viewing strategies:
138138

139139
- **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.
140140

141+
## Contributing
142+
143+
We welcome contributions from the community! To contribute:
144+
145+
- Fork the repository
146+
- Make a development install of jupyterlab-diff
147+
- Create a new branch
148+
- Make your changes
149+
- Submit a pull request
150+
For more details, check out our [CONTRIBUTING.md](https://github.com/jupyter-ai-contrib/jupyterlab-diff?tab=contributing-ov-file#contributing).
151+
141152
## Uninstall
142153

143154
To remove the extension, execute:

0 commit comments

Comments
 (0)