Skip to content

Contributions

Akhil Mahesh edited this page Mar 14, 2025 · 2 revisions

We welcome contributions from developers, researchers, and community members. Your input is vital to improving this project and making it accessible for everyone. Please follow these guidelines to ensure a smooth and collaborative process.


How to Contribute

  1. Fork the Repository
    Create your own fork and clone it locally.

  2. Create a Feature Branch
    Use descriptive branch names that reflect the changes (e.g., fix/gesture-detection-bug, feat/add-new-gesture).

  3. Make Your Changes

    • Code:
      • Follow the established coding standards.
      • Write clear, concise, and well-commented code.
      • Ensure your code is covered by tests.
    • Documentation:
      • Update or add documentation where needed.
      • Ensure changes are reflected in both code comments and Wiki pages.
    • Tests:
      • Add or update tests to cover your changes.
      • Run all tests locally to verify that everything works correctly.
  4. Commit Your Changes
    Write clear commit messages that follow the Conventional Commits style.

    • Example: fix: resolve hand detection crash on low-light conditions
  5. Submit a Pull Request

    • Open a pull request (PR) against the main branch.
    • Provide a detailed description of your changes, referencing any related issues.
    • Include screenshots, logs, or additional context if necessary.
  6. Follow Up on Your Pull Request

    • Respond to feedback from the maintainers.
    • Update your PR as needed based on review comments.

Code of Conduct

We adhere to the Contributor Covenant Code of Conduct to foster an inclusive and respectful community. Please review and follow it in all interactions.


Additional Guidelines

  • Issue Tracking:
    Open an issue in the repository before starting work on a bug fix or new feature to discuss your ideas and avoid duplicate efforts.

  • Communication:
    Engage with the community on GitHub Discussions or contact maintainers directly if you have any questions or need clarifications.

  • Testing:
    Ensure your contributions do not break existing functionality. Run the full test suite locally and add new tests as needed.

  • Documentation:
    Keep all project documentation up to date. Clear, concise, and accurate documentation benefits everyone.


Thank you for your contributions! Your efforts help advance accessibility and improve the Sign Language to Speech Conversion project for all users.

If you have any questions, please join the discussion on GitHub Discussions or open an issue in the repository.

πŸ“Œ Getting Started

  1. Project Overview
  2. Features & Objectives
  3. Installation Guide
  4. Usage Guide

πŸ— Development & Architecture

  1. System Architecture & Design
  2. Implementation Details

πŸ›  Testing & Enhancements

  1. Testing & Quality Assurance
  2. Future Enhancements

🀝 Community & Contributions

  1. Contributing Guidelines
  2. Discussions & Support

πŸ“œ Legal & References

  1. License & References

πŸ“Œ Full Project Report:
πŸ“– Download Detailed Documentation

Clone this wiki locally