-
-
Notifications
You must be signed in to change notification settings - Fork 0
Contributions
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.
-
Fork the Repository
Create your own fork and clone it locally. -
Create a Feature Branch
Use descriptive branch names that reflect the changes (e.g.,fix/gesture-detection-bug,feat/add-new-gesture). -
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.
-
Code:
-
Commit Your Changes
Write clear commit messages that follow the Conventional Commits style.- Example:
fix: resolve hand detection crash on low-light conditions
- Example:
-
Submit a Pull Request
- Open a pull request (PR) against the
mainbranch. - Provide a detailed description of your changes, referencing any related issues.
- Include screenshots, logs, or additional context if necessary.
- Open a pull request (PR) against the
-
Follow Up on Your Pull Request
- Respond to feedback from the maintainers.
- Update your PR as needed based on review comments.
We adhere to the Contributor Covenant Code of Conduct to foster an inclusive and respectful community. Please review and follow it in all interactions.
-
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.
This Wiki serves as the central documentation hub for the Sign Language to Speech Conversion project.
For updates, discussions, or inquiries:
- π Report issues or request features: GitHub Issues
- π¬ Join the discussion: GitHub Discussions
- π€ Contribute to the project: Contribution Guidelines
For any additional questions, please contact the project maintainers through the repository.