First off, thank you for considering contributing to EyeTrace! We welcome all forms of contributions, including bug reports, feature suggestions, documentation improvements, code, tests, and more.
This guide will help you understand how to contribute effectively.
- Code of Conduct
- How Can I Contribute?
- Setting Up the Development Environment
- Coding Conventions
- Testing Your Changes
- Documentation
- Review Process
This project adheres to a Code of Conduct to ensure a respectful and inclusive environment. By participating, you are expected to uphold this code.
If you find a bug, please open an issue on GitHub and follow these steps:
- Search existing issues to see if the bug has already been reported.
- Use a clear and descriptive title.
- Provide step-by-step instructions to reproduce the problem.
- Describe your environment (OS, Python version, dependency versions).
- If possible, include code snippets, screenshots, or log files.
We welcome suggestions for new features or improvements! Please open an issue with:
- A descriptive title.
- A detailed explanation of the proposed functionality.
- Use cases and why it would be valuable.
- If relevant, references to existing work (papers, other implementations).
We love pull requests (PRs)! Here’s how to proceed:
- Fork the repository and create a branch from
mainwith a descriptive name (e.g.,feature/add-perclos,fix/correct-ear-calculation). - Implement your changes following the coding conventions (see below).
- Test your changes thoroughly (add tests if needed).
- Document your changes (update docstrings, the documentation if applicable).
- Push your branch to your fork and open a pull request against
main. - In the PR description, clearly explain:
- What changes you made
- Why they are necessary
- How to test them (if not obvious)
- Link the PR to any related issues (e.g., "Closes #123").
- Clone your fork:
git clone https://github.com/your-username/eyetrace.git cd eyetrace