Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

37 lines (25 loc) · 1.53 KB

Contributing Guidelines

Thank you for considering contributing to our project! We welcome all kinds of contributions including bug reports, feature requests, and code improvements. To ensure a smooth collaboration, please follow the guidelines below.

How to Contribute

Reporting Bugs

  1. Check Existing Issues: Before submitting a bug report, please check if it already exists in the Issues section.

  2. Create a New Issue: If the bug is not listed, create a new issue and provide detailed information:

    • A descriptive title
    • Steps to reproduce the issue
    • Expected and actual results
    • Screenshots or logs, if applicable
    • Your environment (OS, browser, etc.)

    Alteratively, create the issue using the provided repository issue template.

Suggesting Features

  1. Search Existing Feature Requests: Ensure your idea hasn't been suggested already by searching the Issues.

  2. Submit a New Feature Request: If it's a new idea, open a new issue with the following details:

    • A clear and descriptive title
    • A detailed explanation of the feature and its benefits
    • Any relevant examples or use cases

    Alteratively, create the issue using the provided repository issue template.

Contributing Code

  1. Fork the Repository: Create a fork of the repository and clone it to your local machine.
  2. Create a Branch: Make a new branch for your feature or bug fix: 
    git checkout -b your-branch-name