Contribution Guidelines

Welcome to the VAI-Lab contributions page

We are happy you are considering contributing to this project. This page will lay out a short guide on how to contribute to the repo.

Issues

Creating an Issue

If you find a bug or any key features are missing, check if the issue does not already exist, and if not, create an issue on the main UI describing the problem and steps to reproduce if possible

Solving an Issue

If an existing issue is of interest to you, refer to this issue when creating a pull request. Upon reviewing, the issue(s) in question will be closed.

Branches and Pull Requests

When creating a new branch, give it a descriptive name and some form of identifier (e.g. your initials), so the branch list can be kept clean.

Creating pull requests should be done when the feature is complete and the library is fully functional. Merging requires at least 1 review by a maintainer and pull requests are subject to CI test actions being passed, which can be fixed if necessary in the PR if any fail.

Thank you!

Congratulations, your PR has been merged, thank you! Any contributions, large or small are hugely appreciated by the community.