Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/pqoqubbw/icons/llms.txt

Use this file to discover all available pages before exploring further.

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

1

Fork the repository

Fork the repository on GitHub to your account.
2

Clone your fork

Clone your forked repository to your local machine:
git clone https://github.com/pqoqubbw/icons.git
3

Navigate to project

Navigate to the project directory:
cd icons
4

Create a new branch

Create a new branch for your feature or bug fix:
git checkout -b your-branch-name
5

Install dependencies

Install the project dependencies:
pnpm install
6

Create your animated icon

See the Creating Icons guide for detailed instructions on creating new animated icons.
7

Update the registry

After creating a new icon, update the registry so it can be used with the shadcn CLI:
pnpm run gen-cli
This command will automatically sync your new icon to the registry and build the necessary JSON files.
8

Build and test

Build the project to check for errors:
pnpm build
Test the application to ensure your changes work as expected:
pnpm lint
9

Commit your changes

Commit your changes with a descriptive message:
git commit -m "Add [icon-name] animated icon"
10

Push to your fork

Push your changes to your fork:
git push origin your-branch-name
11

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:
  1. Clear Description - Provide a clear description of the icon and animation
  2. Follow Standards - Ensure your code follows the existing patterns
  3. Test Thoroughly - Test your animation across different scenarios
  4. One Icon Per PR - Submit one icon per pull request for easier review
  5. Use Lucide Data - Use exact icon names and keywords from lucide.dev
Thank you for contributing to Lucide Animated!

Build docs developers (and LLMs) love

Get started for freeTalk to us