Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

81 lines (54 loc) · 2.89 KB
Raw

Contribution Guidelines

Welcome to the NativeSensors EyeGestures project! We're excited to have you here and are eager to see your contributions. This document will guide you through the process of contributing to our project.

Code of Conduct

Before you start, please take a moment to review our Code of Conduct. By participating in this project, you agree to abide by its terms.

Getting Started

Join the Community

Join our Discord server to connect with other contributors, ask questions, and collaborate on ideas: Join Here

Fork the Repository

  1. Fork the repository by clicking the "Fork" button on the top right corner of our GitHub repo.
  2. Clone your forked repository to your local machine: 
    git clone https://github.com/YOUR-USERNAME/EyeGestures.git
  3. Navigate to the project directory: 
    cd EyeGestures
  4. Use Devel/Develop branch for your contributions (or use different branch than main)

Create a Branch

Create a new branch for your feature or bug fix:

git checkout -b your-branch-name

Make Changes

Make your changes to the codebase. Ensure your code adheres to the existing style and standards.

Commit and Push Changes

  1. Add and commit your changes:

    git add .
git commit -m "Description of the changes made"

  2. Push your changes to your forked repository:

    git push origin your-branch-name

  3. Add proper tags

    • [WiP] for commit without finished feature, if you want to commit your work for "today" but it is not yet finished, not working, or may break.
    • [Fix] if you found and fixed bug fixing

Open a Pull Request

  1. Navigate to the original repository you forked from.
  2. Click the "Compare & pull request" button.
  3. Provide a descriptive title and detailed description of your changes.
  4. Submit the pull request.

Code Reviews

All submissions, including submissions by project members, require review. We use GitHub's pull request review system to facilitate this process. Your pull request will be reviewed by at least one other contributor.

Reporting Issues

If you find a bug or have an idea for a new feature, please open an issue in the GitHub repository. Provide as much detail as possible to help us understand and address your issue quickly.

Need Help?

If you need help or have questions, feel free to reach out on our Discord server or open an issue on GitHub.

Thank you for contributing! We look forward to collaborating with you. 🚀👩‍💻👨‍💻

GitHub GitHub forks