Contribution Guidelines - LucasCGG/animation-handler-for-rive GitHub Wiki

Thank you for your interest in contributing to Rive Animation Handler! ๐ŸŽ‰ Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Whether you're fixing a bug, improving documentation, or suggesting new features, we welcome your input.

How to Contribute

1. Report Issues

If you find a bug, have questions, or want to suggest improvements: Search the Issues to see if it has already been reported. If not, open a new issue with a clear and concise description.

2. Suggest Features

Have a great idea? Submit a feature request as an issue, and provide as much detail as possible about your idea and its benefits.

3. Submit Pull Requests

We appreciate code contributions! Follow these steps to make a pull request:

  1. Fork the repository to your own GitHub account.
  2. Clone your fork:

git clone https://github.com/your-username/rive-animation-handler.git

  1. Create a new branch for your changes:

git checkout -b feature/your-feature-name

  1. Make your changes and commit:

git commit -m "Add: Your descriptive commit message"

  1. Push to your branch:

git push origin feature/your-feature-name

  1. Open a pull request:

    • Navigate to the main repository.
    • Click the "Pull Request" tab, and then "New Pull Request."
    • Describe your changes and reference any related issues.

Code Style Guidelines

  • Follow clean and consistent coding standards.
  • Use descriptive variable and function names.
  • Add comments where necessary for clarity.

Commit Messages

Write clear and meaningful commit messages. Follow this format:

-Add: For adding new features.

  • Fix: For bug fixes.
  • Update: For small changes or enhancements.
  • Docs: For changes to documentation.

Example:

Add: Support for custom layout fits

Fix: Animation not loading in specific environments

Code of Conduct

By contributing, you agree to abide by our Code of Conduct, which ensures a welcoming and inclusive environment for all.

Questions?

If you have any questions or need assistance, feel free to open an issue or reach out to the maintainers. Weโ€™re here to help!