From 82eab73036a359179d53425781e1e73e5feafe40 Mon Sep 17 00:00:00 2001 From: Ye-Chan Kang Date: Thu, 25 Jan 2024 18:03:28 +0900 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..67f5a69 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. +