Thank you for your interest in contributing to this Open Source Component Library 🎉 Your contributions are highly appreciated and will help make this project better for everyone!
-
Star & Follow (Mandatory)
- Give a ⭐ to this repository.
- Follow my GitHub account for updates.
-
Fork the Repository
- Click on the Fork button at the top-right corner of this repo.
- This will create a copy of the repo in your GitHub account.
-
Clone Your Fork
git clone https://github.com/Gyanthakur/component-library.git cd component-library -
Create a New Branch
git checkout -b feature/your-feature-name
-
Make Your Changes
-
Add/Edit components inside the
components/folder. -
Update documentation if needed.
-
Test your changes by running:
npm run dev
-
-
Commit Your Changes
git add . git commit -m "Added: New Button component"
-
Push Your Changes
git push origin feature/your-feature-name
-
Create an Issue (Before PR)
- Go to the Issues tab and create a new issue describing your contribution (bug fix, new feature, etc.).
-
Raise a Pull Request (PR)
- Go to your forked repository.
- Click on Compare & Pull Request.
- Add a clear title and description of your changes.
- Link the issue number (e.g.,
Closes #12).
-
Review & Merge
- Wait for review.
- Once approved, your PR will be merged 🚀
- Follow proper commit message style (e.g.,
Added: New Card component). - Do not spam with irrelevant PRs (they will be marked invalid).
- Make sure your code follows Next.js + Tailwind best practices.
- Ensure that your changes do not break the existing project.
component-library/
├── app/ # Next.js App Router pages
├── components/ # Buttons, Cards & other UI components
├── public/ # Static assets
├── styles/ # Global CSS
├── package.json
├── tailwind.config.js
└── README.md
If you face any issues, feel free to open a GitHub Issue or contact me directly:
📱 WhatsApp: +91 895-7818-597
