Skip to content

UI Library for Design Engineers. Animated components and effects you can copy and paste into your apps. Free. Open Source.

chore: add PR template with description, motivation, and screenshots sections (#913)

Yeom-JinHo09e3d8dc70a8
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..22b212fe
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,20 @@
+## Description
+<!-- Summarize what this PR changes in 2-4 lines. -->
+
+### Changes
+<!-- List concrete changes by item (e.g., feature, refactor, bug fix). -->
+
+## Motivation
+<!-- Briefly explain why this change is needed and what problem it solves. -->
+
+## Breaking Changes
+<!-- If this affects compatibility, describe impact and migration steps. If not, write None. -->
+
+## Screenshots
+<!-- For UI changes, attach Before/After screenshots and device/browser info. -->
+<!-- Optional for UI changes -->
+> Device / Browser / Viewport:
+
+| Before | After |
+| --- | --- |
+| | |
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 275ad2cd..25fca51e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -2,7 +2,7 @@
Thank you for your interest in contributing to MagicUI! We appreciate your support and look forward to your contributions. This guide will help you understand the directory structure and provide detailed instructions on how to add a new component to MagicUI.
-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!
+Read the [example PR](https://github.com/magicuidesign/magicui/pull/780) 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!
Once done, open a pull request from your forked repo to the main repo [here](https://github.com/magicuidesign/magicui/compare).