This repository has been archived by the owner on Aug 29, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4973d8c
commit edace38
Showing
1 changed file
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. |