This guide outlines how to participate in the Vessel Vision project.
The objective of this document is to set clear expectations for all project participants, encouraging a collaborative approach to enhancement. Following these guidelines helps cultivate a positive and inclusive atmosphere, ensuring a rewarding experience for both contributors and maintainers.
For all contributors: We welcome all contributions to this project! If you notice a bug or have a feature request, please open up an issue here. If you'd like to contribute a feature or bug fix, you can fork our repo and submit a pull request. We will review pull requests within 7 days.
Minor typos or grammatical errors in documentation can be corrected directly via the GitHub web interface, provided the changes are made in the source file.
- Before making a substantial pull request, please open an issue to discuss the proposed change with the team first.
- For bug reports, please provide a minimal reproducible example or reprex. Refer to https://stackoverflow.com/help/minimal-reproducible-example for more info.
NOTE: you may not edit an .md file under main. To prevent this from accidentally happening, the project has been protected to require merge approval from at least two members.
- Create a new Git branch for each pull request (PR), requiring the approval of two members to merge.
- Include DRY code and extensive tests (considering edge cases as well) for new functionality. More info at https://realpython.com/python-testing/
- Update documentation after updating files.
- Every member is expected to write a clear, concise, yet descriptive commit message. The message should explain what problem it is solving, or object it is creating/modifying.
- All new code must adhere to the PEP 8 style guide.
- Consistency is important! Members are expected to ensure homogeneity of style, formatting, and naming conventions.
Please note that this project is released with a Code of Conduct and it can be got here. By contributing to this project, you agree to abide by its terms.
These contributing guidelines were inspired by the Breast_Cancer_Predictor_Project.