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

Commit 8a8a96f

Browse files
Merge pull request #35 from sortxyz/feat/release-docs
feat: add docs on release process
2 parents 4973d8c + edace38 commit 8a8a96f

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,3 +96,38 @@ If you believe you have found a security vulnerability, we encourage you to
9696
responsibly disclose this and not open a public issue. We will investigate all
9797
legitimate reports. Email security@sort.xyz to disclose any security
9898
vulnerabilities.
99+
100+
101+
## Contributing
102+
103+
104+
### Test your change
105+
106+
#### Run a local build
107+
108+
```bash
109+
npm run build
110+
```
111+
112+
#### Link the package
113+
114+
```bash
115+
# do this in this repo
116+
npm run link
117+
```
118+
119+
#### Link the package in your project
120+
121+
```bash
122+
# do this in your project
123+
npm run link @sort/react-components
124+
```
125+
126+
### Prepare for release
127+
128+
if everything works as expected, go ahead and make the commit
129+
130+
131+
#### How to write commits
132+
133+
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.

0 commit comments

Comments
 (0)