Skip to content

Latest commit

 

History

History
82 lines (54 loc) · 1.88 KB

CONTRIBUTING.MD

File metadata and controls

82 lines (54 loc) · 1.88 KB

📄 CONTRIBUTING.md

# Contributing to ButtonJS

🎉 First off, thank you for taking the time to contribute!  
Your help makes *ButtonJS* better for everyone.

---

## 🛠 Ways You Can Contribute
1. **Add New Buttons** — Create unique, modern, and responsive button designs.
2. **Improve Existing Buttons** — Optimize styles, animations, or accessibility.
3. **Fix Bugs** — Found a bug? Squash it!
4. **Enhance Documentation** — Better examples, screenshots, or code comments.

---

## 📦 How to Contribute

### 1. Fork & Clone the Repo
```bash
git clone https://github.com/your-username/ButtonJS.git
cd ButtonJS

2. Create a New Branch

git checkout -b feature/your-feature-name

3. Make Your Changes

  • Use React + TailwindCSS only (no config changes required).
  • Keep designs clean, responsive, and reusable.
  • Use inline Tailwind classes — avoid editing Tailwind config.

4. Commit Your Changes

git add .
git commit -m "Added a new animated gradient button number ButtonJsByHMKCodeWebNumber##"

5. Push and Create Pull Request

git push origin feature/your-feature-name
  • Go to GitHub and create a PR to the main branch.

🎨 Button Design Guidelines

  • Keep the button size, padding, and border radius consistent with other designs.
  • Ensure hover, focus, and active states are visually clear.
  • Test in both light and dark backgrounds.
  • Add small animations for interactivity when possible.

📋 Code Style

  • Use functional components in React.
  • Follow TailwindCSS class ordering for readability.
  • Keep your code clean and commented if needed.

📢 Need Help?

If you get stuck, feel free to:

Thank you for making ButtonJS better! 🚀