# Contributing to BadtzUI 🤝✨ We welcome and appreciate contributions to **BadtzUI**! Whether you're fixing bugs, adding new components, or improving documentation, your help makes the library better for everyone. 🚀 --- ## 📋 Getting Started 1. **Fork** the repository. 2. **Clone** your fork locally: ```bash git clone https://github.com/badtzx0/badtz-ui.git ``` 3. **Navigate** to the project directory: ```bash cd badtz-ui ``` 4. **Install dependencies:** ```bash npm install ``` 5. **Run the project locally:** ```bash npm run dev ``` --- ## 🛠️ Contribution Workflow 1. **Create a new branch** following the naming convention: ```bash git checkout -b feature/your-feature-name ``` 2. **Commit your changes** with meaningful messages: ```bash git commit -m "feat: add new button component" ``` 3. **Push to your fork:** ```bash git push origin feature/your-feature-name ``` 4. **Open a Pull Request (PR):** - Go to the original repository. - Click **New Pull Request**. - Describe your changes clearly. 5. **Wait for review** — We’ll get back to you as soon as possible! 💬 --- ## 📏 Code Guidelines - **Use Prettier** for consistent code formatting. - Follow the **existing code style** (naming, structure, etc.). - **TypeScript:** Ensure type safety across components. - **Use `cn` utility** for managing conditional class names where necessary. - **Prefer `framer-motion`** for animations to maintain consistency across the library. --- ## 🐛 Reporting Bugs If you find a bug: 1. **Open an issue** with the following info: - A clear description of the bug. - Steps to reproduce. - Expected vs actual behavior. - Screenshots (if applicable). 2. **Check existing issues** to avoid duplicates. --- ## 🌟 Suggesting Features Got an idea? We’d love to hear it! - **Open an issue** and use the `enhancement` label. - Explain why the feature would be valuable. --- ## 💡 Need Help? If you're stuck or have questions, feel free to reach out via: - [GitHub Discussions](#) *(Coming Soon)* - [Discord](https://discord.com/invite/SV2y7vz6Es) --- Thanks for contributing to **BadtzUI**! 💖🚀