-
Notifications
You must be signed in to change notification settings - Fork 0
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
Showing
1 changed file
with
36 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 |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Contributing to [bmates-ui](https://github.com/Bandmators/bmates-ui) | ||
|
||
Thank you for your interest! | ||
|
||
All contributions are welcome. | ||
|
||
## Local Development | ||
1. Fork this project. | ||
2. Clone the forked project. | ||
3. Install all dependencies. | ||
4. Run `pnpm dev` or `pnpm storybook` | ||
5. Done! | ||
|
||
## Conventional Commits | ||
|
||
All commit conventions are based on [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). | ||
|
||
|
||
## Pull Requests | ||
|
||
We actively welcome all pull requests :) | ||
|
||
1. Fork the repo and create your branch from `main`. | ||
2. If you've added code that should be tested, add some tests' examples. | ||
3. Issue that pull request! | ||
|
||
## Do Not Worry | ||
|
||
Don't worry. | ||
|
||
Husky will discover any rules you failed to follow. | ||
|
||
1. Check if there are any problems with your test code. | ||
2. Check if there is an issue with your code lint. | ||
3. Check if there is a problem with your commit rules. | ||
|