We welcome contributions to Lucide Animated! Follow these guidelines to ensure your contribution meets our quality standards.
Important Constraints
Based on Lucide Icons Only - This project only accepts contributions based on Lucide icons. Pull requests containing custom icons or icons from other icon packs will be closed. No Simple Path Animations - Pull requests with simple path length animations (strokeDasharray/strokeDashoffset “drawing” effect) will likely be rejected. This type of animation looks generic and doesn’t add meaningful interaction. We’re looking for creative, purposeful animations that enhance the icon’s meaning.
Animation Quality Requirements
Good animations should:
- Enhance the icon’s meaning and purpose
- Be creative and purposeful, not generic
- Use Framer Motion effectively
- Provide meaningful visual feedback on interaction
- Feel smooth and natural
How to Contribute
Fork the repository
Fork the repository on GitHub to your account.
Clone your fork
Clone your forked repository to your local machine:git clone https://github.com/pqoqubbw/icons.git
Navigate to project
Navigate to the project directory: Create a new branch
Create a new branch for your feature or bug fix:git checkout -b your-branch-name
Install dependencies
Install the project dependencies: Create your animated icon
Update the registry
After creating a new icon, update the registry so it can be used with the shadcn CLI:This command will automatically sync your new icon to the registry and build the necessary JSON files. Build and test
Build the project to check for errors:Test the application to ensure your changes work as expected: Commit your changes
Commit your changes with a descriptive message:git commit -m "Add [icon-name] animated icon"
Push to your fork
Push your changes to your fork:git push origin your-branch-name
Open a pull request
Open a pull request on the original repository with a clear description of the icon you’ve added and the animation you’ve implemented.
Pull Request Guidelines
When submitting a pull request:
- Clear Description - Provide a clear description of the icon and animation
- Follow Standards - Ensure your code follows the existing patterns
- Test Thoroughly - Test your animation across different scenarios
- One Icon Per PR - Submit one icon per pull request for easier review
- Use Lucide Data - Use exact icon names and keywords from lucide.dev
Thank you for contributing to Lucide Animated!