From e643c3d22ba608551e2e0934a319d7c72f37d09a Mon Sep 17 00:00:00 2001 From: Kanit Wongsuphasawat Date: Thu, 27 Jun 2024 01:02:25 -0700 Subject: [PATCH 1/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 87bd6742f6..8becd89f9d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -112,7 +112,10 @@ yarn Now you should be able to build and test the code. -3. To serve the website and documentation, you will need [ruby](https://www.ruby-lang.org/en/), [bundler](http://bundler.io/) and [Jekyll](https://help.github.com/articles/using-jekyll-as-a-static-site-generator-with-github-pages/). + +3. To manually test your changes locally, you should have a local instance of [Vega Editor](https://github.com/vega/editor) and link Vega-Lite to the editor (See [Vega Editor's README](https://github.com/vega/editor#local-testing--debugging) for instructions). + +4. To serve the website and documentation, you will need [ruby](https://www.ruby-lang.org/en/), [bundler](http://bundler.io/) and [Jekyll](https://help.github.com/articles/using-jekyll-as-a-static-site-generator-with-github-pages/). For ruby, Mac users can use [homebrew](http://brew.sh) to add it: @@ -209,12 +212,6 @@ We use the [Visual Studio Code](https://code.visualstudio.com/) editor. - Make sure to install [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint), [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) extensions. - The [vscode-jest-runner](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner) extension is also very helpful for debugging tests. -## Manually Testing with Vega-Editor - -To manually test your changes locally, you should have a local instance of [Vega Editor](https://github.com/vega/editor) and link Vega-Lite to the editor (See [Vega Editor's README](https://github.com/vega/editor#local-testing--debugging) for instructions). - -To update the Vega-Lite code in the editor, you need to compile TypeScript to JavaScript. The easiest way is to run `yarn watch` in the Vega-Lite directory. This command will automatically recompile the code whenever you make changes. - ## Pull Requests and Continuous Integration (CI) All pull requests will be tested on [GitHub Actions](https://github.com/features/actions). If your PR does not pass the checks, your PR will not be approved. The CI will run `yarn test`, generate Vega specs and SVG files from your updated code, compare them with the existing compiled outputs in `examples/compiled/`, and check code coverage of your code. If you don't want your PR reviewed until checks pass, mark the [pull request as draft](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests). Once you're ready for review, convert the pull request to mark it as ready for review. From 7c06289382f8457859496487cdc1ced083bfc7fa Mon Sep 17 00:00:00 2001 From: Kanit Wongsuphasawat Date: Thu, 27 Jun 2024 01:04:38 -0700 Subject: [PATCH 2/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8becd89f9d..1cd33c4965 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -113,7 +113,7 @@ yarn Now you should be able to build and test the code. -3. To manually test your changes locally, you should have a local instance of [Vega Editor](https://github.com/vega/editor) and link Vega-Lite to the editor (See [Vega Editor's README](https://github.com/vega/editor#local-testing--debugging) for instructions). +3. To manually test your changes locally, you should have a local instance of [Vega Editor](https://github.com/vega/editor) cloned and link Vega-Lite to the editor (See [Vega Editor's README](https://github.com/vega/editor#local-testing--debugging) for instructions). 4. To serve the website and documentation, you will need [ruby](https://www.ruby-lang.org/en/), [bundler](http://bundler.io/) and [Jekyll](https://help.github.com/articles/using-jekyll-as-a-static-site-generator-with-github-pages/). From cda50f9f5d25539b3b9f7e79ceb4d5bb5809d982 Mon Sep 17 00:00:00 2001 From: Dominik Moritz Date: Sun, 30 Jun 2024 15:08:58 -0400 Subject: [PATCH 3/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1cd33c4965..2ff3ed35f6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -115,7 +115,7 @@ Now you should be able to build and test the code. 3. To manually test your changes locally, you should have a local instance of [Vega Editor](https://github.com/vega/editor) cloned and link Vega-Lite to the editor (See [Vega Editor's README](https://github.com/vega/editor#local-testing--debugging) for instructions). -4. To serve the website and documentation, you will need [ruby](https://www.ruby-lang.org/en/), [bundler](http://bundler.io/) and [Jekyll](https://help.github.com/articles/using-jekyll-as-a-static-site-generator-with-github-pages/). +4. To serve the website and documentation, you will need [ruby](https://www.ruby-lang.org/en/) and [bundler](http://bundler.io/). For ruby, Mac users can use [homebrew](http://brew.sh) to add it: From d7183e3fafb8c4fd48825a5bb2311351903f2bce Mon Sep 17 00:00:00 2001 From: Dominik Moritz Date: Sun, 30 Jun 2024 16:10:55 -0400 Subject: [PATCH 4/4] style: format --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ff3ed35f6..a8616acf84 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -112,7 +112,6 @@ yarn Now you should be able to build and test the code. - 3. To manually test your changes locally, you should have a local instance of [Vega Editor](https://github.com/vega/editor) cloned and link Vega-Lite to the editor (See [Vega Editor's README](https://github.com/vega/editor#local-testing--debugging) for instructions). 4. To serve the website and documentation, you will need [ruby](https://www.ruby-lang.org/en/) and [bundler](http://bundler.io/).