Contributing Guidelines
Thank you for your interest in contributing to UI2Canvas – Create Animations! All contributions—bug fixes, improvements, documentation, or new animation ideas—are welcomed and appreciated.
Please read the guidelines below to ensure smooth and meaningful contributions.
How to Contribute
- Fork the repository
- Create a new branch
git checkout -b
- Make your changes
- Stage your changes
git add
- Commit your changes
git commit -m "Describe your changes here"
- Push to your fork
git push origin
- Open a Pull Request
A good PR consists of:
A short, clear title
Explanation of what changed and why
Screenshots or GIFs if your changes affect animations or visuals
Pull Request Rules
To maintain quality across UI2Canvas:
Create an Issue first, and link it to your PR
Ensure animations run without errors
Keep logic clean and easy to follow
Document any new feature, timeline, state, or rendering update
Maintain consistent naming and project structure
Add comments wherever logic may be unclear
Issue Guidelines
Before creating a new issue:
Check whether an issue already exists
Provide a clear description of the bug, idea, or enhancement
Include screenshots or recordings for visual/animation-related issues
Suggest a possible fix if you can
Testing Your Changes
Before submitting a pull request:
Ensure the engine runs without errors
Check animation behavior
Avoid breaking existing features
Code of Conduct
Be respectful, constructive, and inclusive. Your effort strengthens the project and the open-source community.