Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

70 lines (43 loc) · 2.98 KB
Raw

Contributing

Any and all contributions to Rivet are welcome and encouraged!

If you have any bug reports, questions, ideas, or unexpected behavior feel free to open an issue or start a discussion. It's always a good idea to see if your issue has already been reported before opening a new one.

Running from Source

Prerequisites

Building and Running

Due to the size of the repository (package tarballs are committed), it is recommended to use a blobless clone to download the repository more quickly.

  1. Clone the repository to your local machine, for example using SSH:
git clone --filter=blob:none git@github.com:Ironclad/rivet.git
  1. cd into your the cloned folder and run yarn in the root folder
  2. Start the app in development mode by running yarn dev

IDE Configuration

Rivet makes use of yarn PnP, so some editor configuration may be necessary:

VS Code

  1. Install the ZipFS extension (or install recommended extensions)
  2. Open the command palette and run TypeScript: Select TypeScript Version
  3. Select Use Workspace Version

Other IDEs & Troubleshooting

More information is available here: https://yarnpkg.com/getting-started/editor-sdks

Building Packages

To build all packages, run yarn build in the root folder. This will compile the TypeScript for all packages, and build everything for a production release.

To build a specific package, run yarn build in the package folder. For example, to build the @ironclad/rivet-core package, run yarn build in the packages/core folder.

Tests

To run tests, run yarn test in the root folder. This will run all tests for all packages.

To run tests for a specific package, run yarn test in the package folder. For example, to run tests for the @ironclad/rivet-core package, run yarn test in the packages/core folder.

Testing will also run linting at the same time.

Linting

Rivet uses ESLint for linting and Prettier for formatting. To run linting, run yarn lint in the root folder. This will run linting for all packages.

In VS Code, ESLint is configured to run automatically on save. We also recommend enabling the Format on Save option in VS Code to automatically format files with Prettier on save.