@andreibratila/tailwind-utopia
Version:
A Tailwindcss v4 library for fluid typography and spacing with Utopia
88 lines (58 loc) • 2.18 kB
Markdown
# Contributing to Tailwind Utopia Plugin
Thank you for considering contributing to this project! Your help is greatly appreciated. 🎉
## How to Contribute
### 1. Fork & Clone
1. Fork the repository on GitHub.
2. Clone your fork locally:
```bash
git clone https://github.com/YOUR-USERNAME/tailwind-utopia.git
cd tailwind-utopia
```
3. Install dependencies:
```bash
npm install
```
### 2. Create a Feature Branch
Before making changes, create a new branch:
```bash
git checkout -b feature/my-new-feature
```
### 3. Make Your Changes
- Follow the project’s coding style.
- Ensure your changes don’t break existing functionality.
- Add comments and documentation where necessary.
### 4. Run Tests
If applicable, ensure all tests pass:
No tests for now.
```bash
npm test
```
### 5. Commit & Push
1. Commit your changes following the conventional commit style:
```bash
git commit -m "feat: add new spacing utilities"
```
2. Push to your fork:
```bash
git push origin feature/my-new-feature
```
### 6. Submit a Pull Request
- Open a Pull Request (PR) on the main repository.
- Provide a clear description of your changes.
- The maintainers will review your PR and may request changes.
## Code of Conduct
All contributors are expected to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
## Contributors ✨
A huge thanks to everyone who has contributed to this project!
### How to Get Listed
If you've contributed and would like to be added to this list, open a Pull Request adding yourself below:
| Name | GitHub Profile | Contributions |
| ---------------------- | -------------------------------------------------- | ------------------- |
| Andrei Florian Bratila | [@andreibratila](https://github.com/andreibratila) | Core developer |
| [Another Contributor] | [@anotheruser](https://github.com/anotheruser) | Feature development |
## Need Help?
If you have any questions, feel free to open an issue or start a discussion.
🚀 Happy coding!