Skip to content

Latest commit

 

History

History
85 lines (51 loc) · 3.89 KB

CONTRIBUTING.md

File metadata and controls

85 lines (51 loc) · 3.89 KB
Raw

Contributing

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on https://www.runwasm.com/ ✨.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

See the README to get an overview of the project.

Getting started

Issues

Create a new issue

If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.

Solve an issue

Scan through our existing issues to find one that interests you. Leave a comment on the issue asking if you can pick up the issue so maintainers knowing you want to work on it.

Make Changes

Prerequisites

Make sure you have the following installed in your development environment:

Development Workflow

Follow these steps below to get run-wasm working locally:

  1. Clone the run-wasm repository and cd into it
# Using HTTPS
git clone https://github.com/slipHQ/run-wasm.git
# Or using SSH
git clone [email protected]:slipHQ/run-wasm.git
cd run-wasm

  1. Run yarn in the root directory.

    This will install all the dependencies defined in the package.json file

  2. Run npx lerna bootstrap in the root directory.

    This will link packages together and install their dependencies.

  3. Run yarn build in the root directory.

    This will build the run-wasm package in the lib folder and allow you to import it in the example-nextjs project.

  4. In the example-nextjs project, run yarn.

cd example-nextjs
yarn

  1. Run yarn dev

    🎉 You should be able to see the component at localhost:3000

Pull Request

When you're done making the changes, open a pull request, often referred to as a PR.

  • Fill out the PR description summarizing your changes so we can review your PR. This template helps reviewers understand your changes and the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The Slip team thanks you ✨.

Once your PR is merged, we will add you to the All Contributors Table in the README.md