1
0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-30 02:19:52 +02:00

Add documentation for @next releases to Contributing.md

This commit is contained in:
Sunny Hirai
2020-12-11 13:35:56 -08:00
parent 1d3b3b1dad
commit 228f4fa94f

View File

@@ -45,7 +45,7 @@ The slate repository is a monorepo that is managed with [lerna](https://github.c
To run the build, you need to have the Slate repository cloned to your computer. After that, you need to `cd` into the directory where you cloned it, and install the dependencies with `yarn` and build the monorepo:
```
```shell
yarn install
yarn build
```
@@ -56,7 +56,7 @@ To run the examples, start by building the monorepo as described in the [Reposit
Then you can start the examples server with:
```
```shell
yarn start
```
@@ -66,7 +66,7 @@ To run the tests, start by building the monorepo as described in the [Repository
Then you can rerun the tests with:
```
```shell
yarn test
```
@@ -82,8 +82,20 @@ If you only want to run a specific test or tests, you can run `yarn test --fgrep
Since we use [Lerna](https://lerna.js.org) to manage the Slate packages this is fairly easy, just run:
```js
yarn release
```shell
yarn release:latest
```
And follow the prompts Lerna gives you.
If we are unsure as to the stability of a release because there are significant changes and/or particularly complex changes, release with the `@next` tag.
```shell
yarn release:next
```
If we want to make sure that Slate code follows the prerequisites for a release but without actually publishing, run:
```shell
yarn prerelease
```