Add CONTRIBUTING.md guide#1943
Merged
Merged
Conversation
*Why*: The repo has never had contribution instructions; issue #2 (the earliest open issue, filed at project inception) asks for a CONTRIBUTING.md explaining how to contribute to the extension. *What*: Add a root CONTRIBUTING.md covering prerequisites (Node/Yarn/Python), getting started (yarn install + CLI fetch), building/running (yarn build, F5, watch), testing (the real test:* scripts), code style (yarn fix), the pull request flow, and the manual Contributor License Agreement process required for Databricks-Licensed projects. *Verification*: Commands, scripts, and versions cross-checked against package.json and the README. Prettier-formatted. Docs-only change; no code paths affected. Closes #2 Co-authored-by: Isaac
rugpanov
had a problem deploying
to
test-trigger-is
GitHub Actions
Failure
misha-db
reviewed
Jul 2, 2026
| yarn workspace databricks run test:cov | ||
|
|
||
| # End-to-end / integration tests | ||
| yarn workspace databricks run test:integ |
Contributor
There was a problem hiding this comment.
Integration tests need an environment setup, specific env vars etc...
better to add separate section describing it and linking as pre-requisite on run command
Contributor
Author
There was a problem hiding this comment.
Let's exclude the integration tests completely, add the integration tests section with TODO as a placeholder, as you suggested. As follow-up I create a ticket to fill this placeholder.
misha-db
reviewed
Jul 2, 2026
misha-db
left a comment
misha-db
left a comment
Contributor
There was a problem hiding this comment.
Looks good! missing instructions for e2e env setup
misha-db
approved these changes
Jul 2, 2026
*Why* PR review feedback (misha-db): integration tests need a live workspace and specific env vars, which was not explained. `test:integ` would fail for a contributor following the guide with no indication of what was missing. *What* - Add an "Integration test environment" section documenting the required env vars (DATABRICKS_HOST, TEST_DEFAULT_CLUSTER_ID, and PAT vs OAuth auth), a runnable example, the .databrickscfg profile alternative, and the yarn build / VSIX packaging prerequisite. Vars sourced from src/test/e2e/wdio.conf.ts and the sdk-extensions integ tests. - Link the new section as a prerequisite from the test:integ command comment. *Verification* - npx prettier --check CONTRIBUTING.md → "All matched files use Prettier code style!"
rugpanov
had a problem deploying
to
test-trigger-is
GitHub Actions
Failure
rugpanov
had a problem deploying
to
test-trigger-is
GitHub Actions
Failure
Contributor
|
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
rugpanov
had a problem deploying
to
test-trigger-is
GitHub Actions
Failure
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Adds a root
CONTRIBUTING.md— the repository has never had one.The guide covers:
>=22, Yarn3.2.x, Pythonyarn installand fetching the bundled Databricks CLIyarn build, theF5Extension Development Host, andwatchtest:*scripts (test:lint,test:unit,test:python,test:cov,test:integ)yarn fixand the CI lint gateCloses #2 — the earliest open issue in the repo ("Add contribution instructions"), filed at project inception.
Tests
Docs-only change; no code paths affected. Commands, script names, and versions were cross-checked against
package.jsonand theREADME. The file is prettier-formatted.This pull request and its description were written by Isaac.