UI Library for Design Engineers. Animated components and effects you can copy and paste into your apps. Free. Open Source.
docs: add contributing guide
Dillion Verma30d308afdd26
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdnew file mode 100644index 00000000..2277700f--- /dev/null+++ b/CONTRIBUTING.md@@ -0,0 +1,20 @@+## Intro++First of all, thanks for your interest in supporting this project! We could use all the help we can get to make the best possible experience for our community.++## How to Contribute++1. Install the project locally++```bash+git clone https://github.com/magicuidesign/magicui.git+cd magicui+pnpm i+pnpm dev+```++2. Read the [example PR](https://github.com/magicuidesign/magicui/pull/12) to learn which files you need to add. **You only need to change 5 files to add a new component or effect** and it only takes around 10 minutes of work!++## Ask for help++For any help or questions, please open a new github issue and we will get back to you :)diff --git a/README.md b/README.mdindex 95a11ad3..3a88149b 100644--- a/README.md+++ b/README.md@@ -10,12 +10,7 @@ Visit https://magicui.design/docs to view the documentation.## Contributing-```bash-git clone https://github.com/magicuidesign/magicui.git-cd magicui-pnpm i-pnpm dev-```+Visit our [contributing guide](https://github.com/magicuidesign/magicui/blob/main/CONTRIBUTING.md) to learn how to contribute. It only takes around 5 minutes!## License