Skip to content

Latest commit

 

History

History
95 lines (68 loc) · 3.95 KB

CONTRIBUTING.md

File metadata and controls

95 lines (68 loc) · 3.95 KB

Feedback

See something that should be changed? Want to request a new feature? Open a GitHub Issue!

Development Setup

Ensure Yarn and Visual Studio Code are installed.

It is recommended that you have a DVC project available to test the extension against. We have provided the demo project as part of this repo but feel free to use any DVC project that you have available.

To enable formatting on save in VS Code, install the esbenp.prettier-vscode extension. This is optional, but highly recommended as PRs with improper format will be blocked from merge until the issue is fixed.

Note: When using any project that relies on an isolated python environment (conda, venv, etc) the ms-python.python extension needs to be installed into VS Code. It is used by this extension to locate and utilize the required environment.

Development Environment

The development environment allows contributors to test out the extension. The current repository source is built and loaded into the Extension Development Host as an Extension.

Please be aware that having a separate (.vsix) version of the extension installed will cause all kinds of chaos in your development environment.

  • Open the monorepo root as a project in VS Code

  • Run Tasks: Run Build Task (Ctrl+Shift+b) to start the extension and webview development servers (alternatively run yarn dev-server from the terminal).

  • Open the Extension Development Host, a child instance of VS Code with the results of the dev servers installed as an extension, with Start Debugging (f5).
    Note: selecting the Run Extension option when running the debugger will prevent all other extensions from being loaded into the VS code instance. This will improve the performance of VS code but can cause certain DVC commands to fail if the project uses an isolated python environment (see this note).

  • Open the demo or another DVC project in the Extension Development Host; VS Code will remember the last project opened, so this step only has to be done once.

The demo project

The demo project was initially forked from dvc-checkpoints-mnist, and is provided as a lightweight, convenient testbed to try the extension out with. It is not an exhaustive showcase of DVC's features, so testers are encouraged to try other DVC repositories- especially real-world cases!

  • It is recommended that you create the project's virtual environment with Python 3.8 as some dependencies are not yet available for Python 3.9

  • yarn install is a prerequisite for automatically setting up the demo project.

  • Run yarn setup:venv from the monorepo root (not ./demo) to automatically setup the Python virtual environment in the demo project.

  • Once the environment has been setup you should navigate into the demo folder activate the virtual environment and run dvc pull.

  • In order to run experiments in our demo project we require the Python virtual environment to be loaded.

  • This will happen automatically IF the ms-python.python extension is installed within the VS code instance that you are developing against.

React Component Development with Storybook

Start Storybook with yarn storybook in either the monorepo root or the webview project, and you can develop the React components this plugin uses without requiring VS Code as a dev environment.

There are some discrepancies between the Storybook environment and the environment of a real VS Code extension, custom themes being one big one. Always make sure to try out changed components in the full dev environment before merging!

Resources

Check out the Resources page of our GitHub wiki for a list of relevant docs and related projects.