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.

Sign up for GitHub

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/contribute #1326

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Docs/contribute #1326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1e0c26
k
samijaber Jan 2, 2024
23dd958
move docs
samijaber Jan 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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,
Expand Down
14 changes: 7 additions & 7 deletions developer/README.md → CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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`.
5 changes: 2 additions & 3 deletions README.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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!

Expand Down