diff --git a/.vscode/settings.json b/.vscode/settings.json index aa645897e8..0eb31972af 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,7 +1,7 @@ { "editor.codeActionsOnSave": { - "source.fixAll": true, - "source.organizeImports": true + "source.fixAll": "explicit", + "source.organizeImports": "explicit" }, "typescript.format.enable": true, "editor.formatOnSave": true, diff --git a/developer/README.md b/CONTRIBUTING.md similarity index 87% rename from developer/README.md rename to CONTRIBUTING.md index 66cbdbd736..55f6748387 100644 --- a/developer/README.md +++ b/CONTRIBUTING.md @@ -1,16 +1,13 @@ -# Local Development - -Welcome ⚡️!! If you've found a bug, or have an idea to add a feature we'd love to hear from you. It may save time to first ping the group on [Mitosis' Discord channel](https://discord.com/channels/842438759945601056/935218469799071835) to talk through any ideas or any issues that may be a bug. - ## Project Structure Mitosis is structured as a mono-repo using Yarn (v3) Workspaces. The packages -live under `packages/` and `examples/`: +live under `packages/`: - `core` (`@builder.io/mitosis`): contains the Mitosis engine - `cli` (`@builder.io/mitosis-cli`): contains the Mitosis CLI, and _depends_ on `core` - `fiddle`: contains the code for the interactive Mitosis fiddle, which is hosted at mitosis.builder.io - `eslint-plugin` (`@builder.io/eslint-plugin-mitosis`): contains the Mitosis eslint rules to enforce valid Mitosis component syntax. Yet to be released. +- `starter`: contains the code for the Mitosis `create` comand, a.k.a. `npm create @builder.io/mitosis` ## Installation @@ -55,6 +52,9 @@ PS: don't worry about failing imports in the raw test TSX files. These are not a From there, you can keep iterating until the snapshots look as expected, and the integration tests pass! -### Pre-submit +### Prepare your PR + +Make sure to run these before submitting your PR: -- format: `yarn run fmt:prettier` +- format: `yarn fmt:prettier` to lint all files in the repo. +- update snapshots: `cd packages/core && yarn snapupdate` to update test snapshots in `core`. diff --git a/README.MD b/README.MD index 968bdaebaa..2000ce7ba4 100644 --- a/README.MD +++ b/README.MD @@ -20,7 +20,6 @@ _PS: We are actively looking for folks interested in becoming contributors to Mitosis. If interested, look at our list of [good first issues](https://github.com/BuilderIO/mitosis/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or reach out on our [Discord](https://discord.gg/SNusEyNGsx)_ - ## Table of contents - [Quick Start Guide](#quick-start-guide) @@ -117,7 +116,7 @@ Here are some helpful resources on trying out Mitosis: - [this talk](https://portal.gitnation.org/contents/its-time-to-de-fragment-the-web) by Sami Jaber at React Day Berlin is a great intro to Mitosis. It gives a good overview of the impetus behind Mitosis, and a high-level understanding of its different pieces. - The below video is a brief introduction by Steve Sewell. -[![Mitosis Video](https://cdn.builder.io/api/v1/image/assets%2FYJIGb4i01jvw0SRdL5Bt%2Ffa5c422309ce4fbea9eaa133fa471877)](https://www.youtube.com/watch?v=XQIuv34-K_8 'Mitosis Video') + [![Mitosis Video](https://cdn.builder.io/api/v1/image/assets%2FYJIGb4i01jvw0SRdL5Bt%2Ffa5c422309ce4fbea9eaa133fa471877)](https://www.youtube.com/watch?v=XQIuv34-K_8 'Mitosis Video') ## Docs @@ -170,7 +169,7 @@ _NOTE: this matrix is programmatically generated and should not be manually edit ## Contribute -Interested in contribute? Head over to the [developer](developer/) docs and see how you can get setup & started! +Interested in contribute? Head over to the [developer](./CONTRIBUTING.md) docs and see how you can get setup & started! Once you're ready, checkout our [issues](https://github.com/BuilderIO/mitosis/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) page and grab your first issue!