From edace38d2b8522f7b8b80e9a01ffae95f5176bcb Mon Sep 17 00:00:00 2001 From: Aaron Reisman Date: Wed, 5 Jul 2023 16:10:47 -0700 Subject: [PATCH] feat: add docs on release process --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index e2ead66..9f0e8f5 100644 --- a/README.md +++ b/README.md @@ -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 security@sort.xyz 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.