Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

90 lines (62 loc) · 3.37 KB

Contributing to the Project

Thank you for your interest in contributing to this project! We welcome improvements and suggestions. To ensure that we can track and review contributions effectively, please follow the guidelines below when submitting a contribution.

How to Contribute

  1. Fork the Repository: Start by forking the repository to your own GitHub account.

  2. Clone Your Fork: Clone your fork to your local machine:

    git clone https://github.com/your-username/your-repo-name.git

  3. Create a New Branch: Create a new branch for your changes:

    git checkout -b your-feature-branch

  4. Make Your Changes: Implement your modifications according to the guidelines below.

  5. Commit Your Changes: Commit your changes with a descriptive message:

    git add .
git commit -m "Describe your changes here"

  6. Push Your Changes: Push your changes to your fork:

    git push origin your-feature-branch

  7. Create a Pull Request: Open a pull request from your fork’s branch to the main repository’s branch.

What to Include in Your Pull Request

To help us review your contribution effectively, please include the following details in your pull request description:

  1. Before and After Comparison:

    • Before: Provide a brief description of the original implementation or behavior before your changes. If possible, include screenshots or code snippets showing the original state.
    • After: Describe what has changed after your modifications. Include updated screenshots or code snippets showing the new state.

  2. What You Modified:

    • Changes Made: Clearly outline what you modified in the project. This could include code changes, new features, bug fixes, UI improvements, etc.

  3. Why You Modified It:

    • Reason: Explain why you made these changes. Describe the problem or improvement that led to the modification and any relevant context that helps us understand the purpose of the changes.

  4. How It Looks Now:

    • Results: Provide details on how the modifications improve or alter the project. If applicable, explain any new features or fixes and how they enhance the project.

Example Pull Request Description

### Description

**Before:**
- The carousel component had issues with smooth transitions between images.
- It lacked support for swipe gestures on mobile devices.

**After:**
- Improved transition animations for smoother image changes.
- Added support for swipe gestures on mobile devices.

**Changes Made:**
- Updated CSS transitions for smoother animations.
- Implemented swipe gesture handling using custom hooks.

**Why:**
- Users reported choppy transitions and lack of mobile support.
- Enhancements were made to improve user experience and accessibility.

**How It Looks Now:**
- See the updated carousel in action [here](link-to-demo).
- Screenshot of the updated carousel:
  ![Updated Carousel](link-to-screenshot)

Additional Guidelines

  • Coding Standards: Ensure your code adheres to the project's coding standards.
  • Testing: If applicable, include tests for your changes and ensure they pass.
  • Documentation: Update any relevant documentation to reflect your changes.

Thank You!

Your contributions help make this project better. We appreciate your effort and look forward to reviewing your pull request!