Skip to content
This repository has been archived by the owner on Aug 29, 2023. It is now read-only.

feat: add docs on release process #35

Merged
merged 1 commit into from
Jul 5, 2023
Merged
Changes from all commits
Commits
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
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,38 @@ If you believe you have found a security vulnerability, we encourage you to
responsibly disclose this and not open a public issue. We will investigate all
legitimate reports. Email [email protected] to disclose any security
vulnerabilities.


## Contributing


### Test your change

#### Run a local build

```bash
npm run build
```

#### Link the package

```bash
# do this in this repo
npm run link
```

#### Link the package in your project

```bash
# do this in your project
npm run link @sort/react-components
```

### Prepare for release

if everything works as expected, go ahead and make the commit


#### How to write commits

We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), if you're not familiar with it, please take a look as it will determine the type of release that is created.