1- # Contributing to cssanimation.io
1+ # Contributing to {css}animation
22
3- Thank you for considering contributing to ** cssanimation.io! ** Your help makes this library better for designers and developers around the world.
3+ # 🛠️ Contributing to {css}animation
44
5- This guide will walk you through the setup, standards, and process to ensure smooth collaboration.
5+ Thank you for your interest in contributing to ** {css}animation** .
6+ Your support helps bring better motion design to developers and designers around the world 💛
7+
8+ This guide will walk you through the setup, conventions, and submission process to make collaboration smooth and enjoyable.
69
710## Getting Started
811
9- ### 1. Fork & Clone
12+ ### 1. Fork & Clone the Repository
1013
1114``` bash
12- git clone https://github.com/your-username/cssanimation.io. git
13- cd cssanimation.io
15+ git clone https://github.com/your-username/cssanimation.git
16+ cd cssanimation
1417```
1518
1619### 2. Install dev dependencies
@@ -38,29 +41,26 @@ Branch Naming Guidelines
3841
3942This runs the prefixer, copies assets, and extracts class references.
4043
41- ### 3. Start Contributing
42-
43- Make your changes in the ` src/ ` directory. Avoid editing ` dist/ ` directly.
44-
4544## Project Structure
4645
4746``` bash
4847src/
4948├── cssanimation.css # Core animation styles
5049├── cssanimation-utility.css # Utility modifiers (delay, speed, etc.)
51- └── cssanimation-reference.md # Auto-generated class list
5250```
5351
52+ > Make your changes in the ` src/ ` directory. Avoid editing ` dist/ ` directly.
53+
5454## Naming Conventions
5555
5656CSS Class Prefixes
5757
58- - Use ` ca__ ` for all animation class names
59- - Example: ` .ca__fadeIn ` , ` .ca__gsap-effect3d `
58+ - Use ` ca__fx- ` for all animation class names
59+ - Example: ` .ca__fx-fadeIn `
6060
6161JavaScript Targets
6262
63- - Always wrap selectors in ` document.querySelector ` or GSAP-safe strings
63+ - Always wrap selectors in ` document.querySelector `
6464- Avoid hardcoding non-prefixed class names
6565
6666## Scripts
@@ -80,7 +80,7 @@ JavaScript Targets
8080
8181- Use 2 spaces for indentation
8282- Write clear, concise comments
83- - Use semantic naming (e.g. .ca \_\_ bounceInLeft > .bL )
83+ - Use semantic naming (e.g. ` .ca__bounceInLeft ` )
8484- Prefer SCSS-like readability in raw CSS
8585
8686## Submitting a Pull Request
@@ -94,7 +94,7 @@ git checkout -b feature/your-change
9494Commit clearly
9595
9696``` bash
97- git commit -m " Add: new animation ca__flashFadeIn "
97+ git commit -m " Add: new animation ca__fx-flashFadeIn "
9898```
9999
100100Push to your fork
@@ -116,8 +116,7 @@ Open a GitHub Issue with:
116116
117117## Maintainer
118118
119- - Email: hello@cssanimation.io
119+ - Email: yesiamrocks@gmail.com
120120- [ LinkedIn] ( https://www.linkedin.com/in/shafayetul/ )
121- - [ cssanimation.io] ( cssanimation.io )
122121
123122Thank you again for your contributions 💛
0 commit comments