Skip to content

Commit 4a3a17a

Browse files
committed
updated
1 parent 9dddb9b commit 4a3a17a

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,4 +93,50 @@ For full **features**, **class names**,**playground**, **demos**, and **advanced
9393

9494
⭐ If you find this project useful, consider [dropping a star](https://github.com/Srinanth/ani-js) on GitHub!
9595

96+
---
97+
98+
## 🤝 Contributing
99+
100+
### 🧭 Getting Started
101+
102+
1. **Fork** the repository
103+
2. **Clone your fork locally**
104+
```bash
105+
git clone https://github.com/Srinanth/Ani-Js.git
106+
cd ani-js
107+
```
108+
3. **Create a feature branch**
109+
```bash
110+
git checkout -b addition/new-animation
111+
```
112+
4. **Make changes** – Add new animations, improve logic, or refactor existing code
113+
5. **Commit your changes**
114+
```bash
115+
git commit -m "✨ Added New Animation"
116+
```
117+
6. **Push to your branch**
118+
```bash
119+
git push origin addition/new-animation
120+
```
121+
7. **Open a Pull Request** on GitHub
122+
123+
---
124+
125+
### 📐 Development Guidelines
126+
127+
- **Code Style**: Follow existing patterns used in JavaScript, CSS, and React files
128+
- **Animations**: Keep utility class names consistent (`tw-fade-in`, `tw-zoom-in`, etc.)
129+
- **Testing**:
130+
- Manually test animations using the local playground page
131+
- Add unit tests where applicable *(planned for future integration)*
132+
- **CSS**: Avoid bloated styles — Ani-Js is meant to stay minimal and fast
133+
- **Performance**: Prefer CSS-based animations over JS unless JavaScript is required
134+
135+
---
136+
137+
### 🧪 Local Dev Tips
138+
139+
- Use the [Vite](https://vitejs.dev) dev server for rapid development
140+
- Run a local playground to test all animations in real-time
141+
96142
---

0 commit comments

Comments
 (0)