Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (39 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

50 lines (39 loc) · 2.19 KB

Contributing to the Animation Library

First off, thank you for considering contributing! As a solo developer, your help is greatly appreciated. Every contribution, from a small typo fix to a new feature, is valuable.

This document provides a set of guidelines for contributing to this repository.

How Can I Contribute?

There are many ways to contribute, including:

  • Reporting bugs
  • Suggesting enhancements or new features
  • Submitting pull requests with code changes
  • Improving the documentation

Reporting Bugs

If you find a bug, please ensure it hasn't already been reported by searching the existing Issues.

If you're creating a new bug report, please include as much detail as possible:

  • A clear and descriptive title.
  • Steps to reproduce the bug. Provide a minimal code example that demonstrates the issue.
  • What you expected to happen.
  • What actually happened.
  • Your environment (e.g., Java version, OS).

Submitting Pull Requests

We love pull requests! To ensure a smooth process, please follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Create a new branch for your changes. Please use a descriptive name. 
    git checkout -b feature/your-amazing-feature
  3. Make your changes. Write clean, readable code that follows the existing style of the project.
  4. Add or update tests if your changes affect the code's behavior.
  5. Update the documentation (e.g., README.md) if you are adding or changing a feature.
  6. Commit your changes using a clear and descriptive commit message. We follow the Conventional Commits specification. 
    # Example commit messages
git commit -m "feat(Easing): add new elastic functions"
git commit -m "fix(Animation): prevent delay from reapplying on repeat"
  7. Push your branch to your fork on GitHub. 
    git push origin feature/your-amazing-feature
  8. Open a pull request to the main branch of the original repository. Provide a clear title and description of your changes.

Thank you again for your contribution!