Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (35 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

57 lines (35 loc) · 1.44 KB

Contributing to solid-headless

Please read the Code of Conduct first.

Developing

The development branch is main and this is the branch that all pull requests should be made against.

To develop locally:

  1. Fork this repository to your own Github account and then clone it to your local device.
  2. Create a new branch:
git checkout -b MY_BRANCH_NAME
  1. Install yarn:
npm install -g yarn
  1. Install dependencies with:
yarn
  1. Link dependencies with
yarn bootstrap

Developing packages

To develop a package, open your terminal on packages/PACKAGE_NAME.

  • Use yarn build to build the source of the package.
  • Use yarn clean to clean the build directory.
  • Use yarn type-check to perform type-checking.
  • Use yarn lint to perform linting.

You can also use the same commands on the project root.

Developing examples

Examples are made through Vite. Examples should be marked as private packages (through "private": true in package.json) to keep them from being published. When using local packages as dependencies, make sure to use the exact version in the "dependencies" of the examples.

Repository Management

The development of this project heavily relies on the use of Classic Yarn (1.x) for managing packages and Lerna for managing the workspace.

Styling

TODO