Skip to content

Latest commit

 

History

History
59 lines (47 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

59 lines (47 loc) · 3.33 KB

Contributing to Learning Motion

Thank you for your interest in contributing to the Learning Motion project! This project is aimed at creating exciting new animations and motion-related components using React. Whether you're interested in building something new, enhancing existing features, or improving documentation, your contribution is valuable!

How Can I Contribute?

1. Creating New Animations or Motion Components

We are always looking to expand the variety of animations and motion effects. If you have a new idea for an animation or motion component:

  • Create a new issue titled "New Animation: [name of the animation]."
  • Describe what the animation or effect will do and how it might be used in a React project.
  • You can also attach links, videos, or examples of the motion you aim to replicate or improve.

2. Enhancing Existing Animations

You can contribute by improving existing animations, making them more efficient, customizable, or smoother. For this:

  • Find an animation or component in the repository that you'd like to enhance.
  • Open an issue or comment on the relevant issue with your ideas and improvements.
  • Feel free to suggest better performance techniques, customization options, or alternate animation styles.

3. Improving Documentation and Examples

Clear documentation and examples are essential for developers to understand how to use animations in their React projects. You can help by:

  • Writing detailed usage examples and tutorials for existing components.
  • Adding or improving explanations for the API, props, and settings available in the components.

4. Proposing New Features

If you have a feature idea that could benefit the project, such as a new animation library integration or tool for motion, follow these steps:

  • Open a new issue titled "Feature Request: [feature name]."
  • Provide a detailed description of the feature and its potential benefits.
  • Include sketches, diagrams, or videos if applicable.

5. Getting Started with a Contribution

Before You Start:

  • Check the issue tracker to see if anyone is already working on a similar idea.
  • Comment on the issue you're interested in to express your intent to work on it.

Process:

  1. Fork the repository to your GitHub account.
  2. Clone your fork locally using:
    git clone https://github.com/q1akm/Learning-motion.git
  3. Create a new branch for your contribution:
    git checkout -b new-animation-[your-idea]
  4. Develop your new animation, motion component, or documentation improvement.
    • Ensure your code follows the project's guidelines.
    • Test the animation in a React app.
  5. Push your branch to your fork:
    git push origin new-animation-[your-idea]
  6. Create a Pull Request (PR) from your branch:
    • Provide a detailed description of your contribution.
    • Include a live demo or screenshots showing your animation or component in action.
    • Wait for feedback and review.

6. Code Style

We follow React and JavaScript best practices. Please ensure your code is clean, modular, and well-documented before submitting a pull request.

7. Running Tests

Before submitting, please make sure your code passes all tests. If the project includes test suites for animations, run them using:

npm run dev