We welcome contributions to the VisionCycle project! If you would like to contribute, please follow these guidelines to help ensure a smooth process for everyone.
There are many ways you can contribute to our project:
- Code Contributions: If you have improvements to code, documentation, or other aspects of the project, please send us a pull request.
- Bug Reports: Issues are tracked as GitHub issues. If you find a bug in the project, please submit a bug report that describes the issue, along with any relevant details that can help us replicate the problem.
- Feature Requests: If you have ideas for new features or improvements, please submit an issue labeled as a feature request.
- Documentation Improvements: Enhancements or corrections to our documentation are greatly appreciated.
- Fork the repository and create your branch from
master. - If you've added code that should be tested, add tests.
- Ensure the test suite passes.
- Make sure your code lints.
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
- Issue that pull request!
We have committed to ensuring participation in this project is a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion. We do not tolerate harassment of participants in any form.
This Contributing guide is adapted from the open-source contribution guidelines for Facebook's Draft.
Thank you for considering contributing to VisionCycle. We look forward to your contributions!