Skip to content
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.

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

docs: update CONTRIBUTING.md #9379

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: update CONTRIBUTING.md #9379

wants to merge 4 commits into from

Conversation

kanitw
Copy link
Member

@kanitw kanitw commented Jun 27, 2024

Moving the important step about having a local instead of Vega Editor to be in the repo set up storage.

@domoritz Since you have changed editor setup recently, can you make further update if there is anything missing?

@kanitw kanitw requested a review from a team as a code owner June 27, 2024 08:03

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.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't copy the "watch" part over since we shouldn't need it if we no longer build. But @domoritz feel free to further correct because I don't know what additional change you've made recently.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@domoritz domoritz changed the title Update CONTRIBUTING.md docs: update CONTRIBUTING.md Jun 30, 2024
@domoritz domoritz enabled auto-merge (squash) June 30, 2024 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants