docs: contributing.md

CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# SV Contributing Guide
+
+## Workflow
+
+We follow the standard fork-based workflow:
+
+1. **Fork** this repository to your GitHub account.
+2. **Clone** your fork locally.
+3. **Create a new branch** for your change:  
+   `git checkout -b your-feature-name`
+4. **Commit and push** your changes to your branch.
+5. **Open a pull request** from your branch to the `main` branch of this repository.
+
+Please keep your pull requests focused to feature or issue. Focused smaller changes are easier to review and faster to merge.
+
+## Preparing
+This is a monorepo, meaning the repo holds multiple packages. It requires the use of [pnpm](https://pnpm.io/). You can [install pnpm](https://pnpm.io/installation) with:
+
+```bash
+npm i -g pnpm
+```
+
+For running certain packages and tests locally you will need to install [docker](https://docs.docker.com/get-started/get-docker).
+Linux users, you will have to ensure 'sudo' is not required. See [docker post install](https://docs.docker.com/engine/install/linux-postinstall/)
+
+`pnpm` commands run in the project's root directory will run on all sub-projects. You can checkout the code and install the dependencies with:
+
+```bash
+git clone [email protected]:YOUR_GITHUB_USER_HERE/cli.git
+cd cli
+pnpm install
+```
+
+## build/run
+Build the project from root run 'build' script:
+
+```bash
+#from root of project
+pnpm build
+```
+This outputs into /packages/PACKAGE/dist/.
+
+Run the 'cli' package:
+```bash
+node ./packages/cli/dist/bin.js
+```
+
+## testing
+Run all tests:
+```bash
+#from root of project
+pnpm test
+```
+
+Run package specific tests by navigating to the package and running the test command. Eg:
+```bash
+cd packages/core/
+pnpm test
+```
+
+- DIRECTION REQUIRED: how to write tests. 
+
+## styleguide
+
+### Coding style
+
+There are a few guidelines we follow:
+
+- Internal variables are written with `snake_case` while external APIs are written with `camelCase`
+- Ensure `pnpm lint` and `pnpm check` pass. You can run `pnpm format` to format the code
+- linting
+```bash
+#from root of project
+pnpm lint
+```
+- formatting
+```bash
+# from root of project
+pnpm format
+```
+- checking
+```bash
+# from root of project
+pnpm check
+```
+
+## svelte-migrate
+- TODO: check issue #494 for further details on what is needed for svelte-migrate
+