docs: updating contribution guide to be cleaner #97
Conversation
Yggdrasill501
requested review from
Artmann,
jamesbhobbs and
saltenasl
as code owners
📝 WalkthroughWalkthroughCONTRIBUTING.md was rewritten for the Deepnote VS Code extension: repository and branding references updated to deepnote/vscode-deepnote. The document adds a short introduction, explicit prerequisites and setup steps (macOS/Homebrew, nvm/Node, npm, Python, VS Code and recommended extensions), removes GitHub Packages access instructions for @deepnote/blocks, adjusts Apple Silicon notes, clarifies clone/install/build workflows (watch/incremental and full builds), consolidates a "Running the extension" workflow (quick start, Extension Development Host, watch, reload, debug), expands debugging tips, normalizes unit/integration test instructions, and refines local build/packaging steps. No public/exported code signatures changed. Sequence Diagram(s)sequenceDiagram
autonumber
participant Dev as Developer
participant Repo as deepnote/vscode-deepnote
participant Local as Local Env (nvm/Node/Homebrew)
participant VSCode as VS Code (Ext Host)
note over Dev,Repo #f0f4ff: Setup & clone
Dev->>Repo: git clone deepnote/vscode-deepnote
Dev->>Local: install Node, npm, Python, VS Code & extensions
note over Dev,VSCode #f6ffed: Run & develop
Dev->>VSCode: launch Extension Development Host (watch/build)
VSCode->>Local: load extension from workspace
VSCode-->>Dev: extension active (reload/debug)
note over Dev,Local #fff7e6: Test & iterate
Dev->>Local: run unit/integration tests, watch/rebuild
Local-->>Dev: test results/logs
sequenceDiagram
autonumber
participant Dev as Developer
participant VSCode as VS Code
participant ExtHost as Extension Host
participant Debugger as Debugging Tools
participant Env as Local Env
note over Dev,VSCode #f0f7ff: Development loop
Dev->>VSCode: start Quick Start / launch config
VSCode->>ExtHost: spawn Extension Development Host
ExtHost->>Dev: extension loaded
Dev->>ExtHost: exercise commands/UI
Dev->>Debugger: attach / set breakpoints
Debugger-->>ExtHost: step/inspect
ExtHost-->>Dev: logs/errors
alt env/auth issues
Dev->>Env: set env vars / PAT / npm auth
Env-->>Dev: updated environment
end
Possibly related PRs
Suggested reviewers
Pre-merge checks❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: ASSERTIVE Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
🔇 Additional comments (2)
Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #97 +/- ##
=====================================
Coverage 72% 72%
=====================================
Files 545 545
Lines 41889 41889
Branches 5058 5058
=====================================
Hits 30518 30518
Misses 9683 9683
Partials 1688 1688 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
CONTRIBUTING.md (1)
120-134: Fix typo: "dependecies" → "dependencies".Line 120 has a misspelling.
-Install the dependecies: +Install the dependencies:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
CONTRIBUTING.md
23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
24-24: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
41-41: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
42-42: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
67-67: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
169-169: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
212-212: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Build & Test
- GitHub Check: Lint & Format
- GitHub Check: Build & Package Extension
- GitHub Check: copilot-setup-steps
🔇 Additional comments (3)
CONTRIBUTING.md (3)
1-3: Nicely rebranded and welcoming intro.Clear value proposition for contributors.
105-118: Clarify the incomplete npm install command.Line 116 ends with
npm install zeromq@but lacks a version specifier. Should this bezeromq@latest, a pinned version, or has the command been truncated?If this is intentional, consider documenting why no version is specified. If it should have a version, propose a fix.
162-235: Comprehensive new sections for running and debugging the extension.The "Running the Extension," "Available Debug Configurations," and "Debugging Tips" sections are well-structured, actionable, and a clear improvement over the old guidance. Good use of details/summary pattern for optional info.
Yggdrasill501
force-pushed
the
filipzitny/mar-253-contributing-guide-for-deepnotevscode-deepnote
branch
from
c814d87 to
2beb13a
Compare
jamesbhobbs
changed the title
saltenasl
left a comment
saltenasl
left a comment
There was a problem hiding this comment.
please also fix the title of the PR
Yggdrasill501
changed the title
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (5)
CONTRIBUTING.md (5)
9-10: Remove hardcoded Node and npm versions from prerequisites.The .nvmrc file is the single source of truth for the Node version. Hardcoding versions here creates maintenance burden and inconsistency. Refer developers to
.nvmrcinstead, as the installation scripts below already do.Apply this diff:
### Prerequisites -1. [Node.js](https://nodejs.org/) 22.15.1 -2. [npm](https://www.npmjs.com/) 10.9.2 +1. [Node.js](https://nodejs.org/) (version specified in [.nvmrc](.nvmrc)) +2. [npm](https://www.npmjs.com/) (comes with Node.js)
129-129: Fix typo: "dependecies" → "dependencies".-Install the dependecies: +Install the dependencies:
255-286: Update stale references from vscode-jupyter to vscode-deepnote.This section duplicates/conflicts with the updated "Running the Extension" section above (lines 171–247) and references the old Jupyter repo. Remove or consolidate.
-To test changes, open the `vscode-jupyter` folder in VSCode, and select the workspace titled `vscode-jupyter`. -Then, open the debug panel by clicking the `Run and Debug` icon on the sidebar, select the `Extension` -option from the top menu, and click start. A new window will launch with the title -`[Extension Development Host]`. +This section is covered in detail above under "Running the Extension."
401-401: Update wiki link to Deepnote repo.Line 401 links to the old microsoft/vscode-jupyter wiki. Either remove the reference or update to point to Deepnote's documentation if it exists.
-At a high level we have a bunch of folders. Each high level is described in this wiki [page](https://github.com/microsoft/vscode-jupyter/wiki/Source-Code-Organization) +At a high level we have a bunch of folders. Each high level is described in the repository structure.
388-388: Update CONTRIBUTING.md line 388 to remove the outdated vscode-jupyter link.The current link points to microsoft/vscode-jupyter, which is incorrect for the Deepnote repository. The file exists at
src/platform/common/utils/localize.tsin this repo. Use the relative path as suggested, or update the link to point to the correct Deepnote repository.Also note: Several other vscode-jupyter references appear in CONTRIBUTING.md (lines 255, 333, 341, 401, 407, 414-418) that may warrant review as well.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Lint & Format
- GitHub Check: Build & Package Extension
|
some valid rabbit comments here @Yggdrasill501 |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
CONTRIBUTING.md (2)
125-125: Fix typo: "dependecies" → "dependencies".
249-254: Update stale reference from vscode-jupyter to vscode-deepnote.This section references "vscode-jupyter" folder and workspace, but the file was rebranded to Deepnote and line 78 clones
vscode-deepnote. Update instructions to match.Suggested fix:
-To test changes, open the `vscode-jupyter` folder in VSCode, and select the workspace titled `vscode-jupyter`. +To test changes, open the `vscode-deepnote` folder in VSCode, and select the workspace titled `vscode-deepnote`.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Build & Test
- GitHub Check: Lint & Format
- GitHub Check: Build & Package Extension
🔇 Additional comments (2)
CONTRIBUTING.md (2)
167-243: Well-structured developer workflow.The new "Running the Extension" section is clearly organized with practical step-by-step guidance and helpful debugging tips. References align with the Deepnote product (e.g.,
.deepnotefile extension). Good addition.
384-384: Update remaining Microsoft vscode-jupyter references for Deepnote context.Multiple sections retain hardcoded links to
github.com/microsoft/vscode-jupyter(lines 384, 397, 410–419). Since the file was rebranded for the Deepnote fork (vscode-deepnote), these references should be updated or replaced with Deepnote-specific documentation. Check whether:
- Equivalent wiki pages exist in the Deepnote repo
- Test paths (e.g.,
src/test/datascience) exist in the Deepnote fork- Legacy Microsoft references should remain for historical context or be removed
Also applies to: 397-397, 410-419
…epnotevscode-deepnote
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
CONTRIBUTING.md (2)
80-80: Fix typo: "dependecies" → "dependencies".-Install the dependecies: +Install the dependencies:
204-209: Remove redundant section; covered by "Running the extension".Lines 204–209 are now superseded by the comprehensive "Running the extension" section (122–198) above. Delete this older, less detailed guidance to avoid confusion.
-### Run dev build and validate your changes - -To test changes, open the `vscode-jupyter` folder in VSCode, and select the workspace titled `vscode-jupyter`. -Then, open the debug panel by clicking the `Run and Debug` icon on the sidebar, select the `Extension` -option from the top menu, and click start. A new window will launch with the title -`[Extension Development Host]`. -
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
CONTRIBUTING.md(12 hunks)
jamesbhobbs
deleted the
filipzitny/mar-253-contributing-guide-for-deepnotevscode-deepnote
branch
This pull request update the contributions.md to be better readable and cleaner
Summary by CodeRabbit