Add CONTRIBUTING.md file for zenml vscode extension

CONTRIBUTING.MD

@@ -0,0 +1,39 @@
+# Contributing to the ZenML Visual Studio Extension
+
+This guide will help you set up your environment for development and testing.
+
+## Setting Up Your Development Environment
+
+To contribute to the ZenML Studio extension, you'll need to set up a development environment. This includes forking and cloning the extension repository, and setting up a ZenML starter project for testing purposes.
+
+### 1. Fork the Repository
+
+Go to https://github.com/zenml-io/vscode-zenml and fork the repository to your own GitHub account.
+
+### 2. Clone the Extension Repository
+
+Clone the extension repository to your local machine:
+
+```bash
+git clone https://github.com/your-username/vscode-zenml.git
+cd vscode-zenml
+```
+
+### 3. Set Up a ZenML Starter Project
+
+For testing the extension, you'll need an actual stack to test commands on. For a quick setup, follow the [ZenML "A starter project" guide](https://docs.zenml.io/user-guide/starter-guide/starter-project) to set up a starter project. If you don't have a specific directory structure in mind, consider creating a parent directory with two subdirectories: one for the extension and one for the ZenML starter project.
+
+If you followed the guide, which instructs you to create a `zenml_starter` directory containing the stack, your directory structure will look like this:
+
+```bash
+/your-workspace-directory
+    /vscode-zenml
+    /zenml_starter
+```
+
+`vscode-zenml`: The actual extension directory
+`zenml_starter`: The stack directory
+
+## Pull Requests
+
+Please follow the guidelines in [CONTRIBUTING.md](https://github.com/zenml-io/zenml/blob/main/CONTRIBUTING.md) from the main `zenml-io` repo.

README.md

@@ -1,2 +1,73 @@
 # vscode-zenml
+
 VSCode extension for ZenML
+
+Working name: "ZenML Studio"
+
+## Features
+
+Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
+
+For example if there is an image subfolder under your extension project workspace:
+
+\!\[feature X\]\(images/feature-x.png\)
+
+> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
+
+## Requirements
+
+If you have any requirements or dependencies, add a section describing those and how to install and configure them.
+
+## Extension Settings
+
+Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
+
+For example:
+
+This extension contributes the following settings:
+
+- `myExtension.enable`: Enable/disable this extension.
+- `myExtension.thing`: Set to `blah` to do something.
+
+## Known Issues
+
+Calling out known issues can help limit users opening duplicate issues against your extension.
+
+## Release Notes
+
+Users appreciate release notes as you update your extension.
+
+### 1.0.0
+
+Initial release of ...
+
+### 1.0.1
+
+Fixed issue #.
+
+### 1.1.0
+
+Added features X, Y, and Z.
+
+---
+
+## Following extension guidelines
+
+Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
+
+- [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
+
+## Working with Markdown
+
+You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
+
+- Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
+- Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
+- Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.
+
+## For more information
+
+- [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
+- [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
+
+**Enjoy!**