Skip to content

Latest commit

 

History

History
84 lines (53 loc) · 3.41 KB

Contribute.md

File metadata and controls

84 lines (53 loc) · 3.41 KB

How to Contribute

Thank you for your interest in contributing to this project! Your contributions help make this project better for everyone. Please follow the guidelines below to contribute effectively.

This project was launched with the hope of making coding fun and accessible for all levels of proficiency, whether that you are a student or not. We hope that this guide will provide engaging learning opportunities and encourage you to build awesome things yourself!

New Here?

Welcome to the CodeNetwork Gesture Recognition project! There are many ways you can contribute which we hope to outline in this document.

We encourage you to join the Code Network Discord Server and to select the projects that you would be interested in contributing to so that you can see the relevant channels for these projects.

Additionally, we recommend you visit the Open Source Guide's "How to Contribute" guide for more ideas and information about how you can contribute to an open-source project such as this one.

Code of Conduct

By contributing to this project, you agree to abide by the Code Network Code of Conduct. This Code of Conduct applies the same to online projects as it does our in-person events, and is designed to ensure that all people involved with our club are able to have a positive experience with our programs.

📌 Reporting Issues & Bugs

If you find a bug, have a suggestion, or need help, please use the GitHub Issues feature:

  1. Navigate to the Issues tab in this repository and check if there are any existing issues related to your idea.
  2. Click on New Issue, use the appropriate template and describe the problem in detail. (Please be aware that our community may request further detail or discussion regarding your posted issue)
  3. Assign relevant labels if possible.

🔄 Adding Features and Code (PR)

If you want to contribute code to this project, follow these steps:

1️⃣ Fork the Repository

  1. Click the Fork button at the top right of the repository.

  2. Clone your fork locally:

    git clone https://github.com/tdela12/CN20251_GestureRecognition.git

2️⃣ Create a New Branch

Before making changes, create a new branch:

git checkout -b feature-branch-name

3️⃣ Make Your Changes

  • Implement your feature or fix.
  • If possible, follow coding best practices and ensure your code is clean and documented.
  • Run tests and verify functionality before committing.

4️⃣ Commit & Push

Commit your changes with a meaningful message:

git add .
git commit -m "Added feature XYZ"
git push origin feature-branch-name

5️⃣ Create a Pull Request (PR)

  1. Go to your forked repository on GitHub.
  2. Click on Compare & Pull Request.
  3. Provide a clear title and description for your PR.
  4. Ensure your PR references any related issue (e.g., Fixes #123).
  5. Submit the PR and wait for a review.

✅ Contribution Guidelines

  • Keep PRs small and focused on a single issue or feature.
  • Follow the project's coding style.
  • Write clear commit messages.
  • Update relevant documentation if needed.
  • Be respectful and constructive in code reviews.

🤝 Join the Discussion

If you have any questions about these guidelines, we recommend that you reach out through our Discord server, linked above. Alternatively, send us an email via [email protected] and we will be more than happy to assist!

Thank you for your contributions! 🎉