First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
And if you like the project but don’t have time to contribute, you can still support us in other ways:
- ⭐ Star the project
- 🐦 Tweet about it
- 🔗 Mention this project in your blog, readme, or at meetups
This project follows a Code of Conduct to ensure a welcoming environment. Please read it before participating in discussions or submitting contributions.
Before you ask a question, search existing Issues in case it has already been answered. If you still need clarification:
- Open an Issue with as much context as possible.
- Provide relevant project/platform versions (e.g., Node.js, npm, browser).
- Be patient, and the maintainers will respond as soon as possible.
By contributing to this project, you confirm that:
- You authored 100% of the content you contribute.
- You have the necessary rights to the content.
- Your contributions can be licensed under the project’s license.
To help us fix bugs efficiently:
✅ Ensure you are using the latest version.
✅ Verify that it is an actual bug and not a setup issue.
✅ Search existing issues before opening a new one.
✅ Gather relevant details:
- Stack trace (if applicable)
- Operating System & Platform (Windows/macOS/Linux, x86/ARM)
- Version details (browser, Node.js, dependencies)
- Steps to reproduce the bug
- Title: Use a clear and descriptive title.
- Steps to Reproduce: Provide a step-by-step explanation.
- Expected Behavior: Explain what should happen.
- Actual Behavior: Describe what happens instead.
- Screenshots/GIFs: If applicable, attach visuals.
- Logs/Error Messages: Include any relevant logs.
🚨 Security Vulnerabilities: Do not report security issues publicly! Instead, email the maintainers directly.
If you have ideas for new features or improvements:
✅ Ensure you are using the latest version.
✅ Search for existing suggestions before opening a new issue.
✅ Clearly explain how your suggestion improves the project.
- Title: Use a clear and descriptive title.
- Description: Provide a step-by-step explanation of your idea.
- Current Behavior: Explain what currently happens.
- Expected Behavior: Describe how it should work.
- Alternatives Considered: Mention any alternative solutions.
- Screenshots/GIFs: If applicable, attach visuals.
- Benefits: Explain why this enhancement is valuable.
If you’re new to open-source contributions:
- Fork this repository and clone it locally.
- Check open issues and find a beginner-friendly one.
- Create a feature branch (
git checkout -b feature-branch). - Commit your changes following the styleguide.
- Push to your fork and submit a Pull Request (PR).
We will review your PR and provide feedback if needed. 🚀
Follow this format for commit messages:
[Type] Short, concise description
- More details if necessary
- Reference related issue(s) if applicable
✅ feat: Add async audio processing
✅ fix: Resolve video playback lag
✅ docs: Update README with new setup guide
✅ refactor: Improve sign language gesture rendering
Interested in becoming a core contributor?
- Actively contribute and engage in discussions.
- Help review and merge pull requests.
- Be consistent with contributions and improvements.
We appreciate your support in making GestureGuru a success! 🚀