Skip to content

Contributing

Thank you for your interest in contributing to ovi!

If you don’t have time to contribute code or documentation, that’s completely fine — even starring the repository helps others discover ovi and is genuinely appreciated.

Reporting bugs and security issues

  • Open a GitHub issue for any bugs, feature requests, or general problems.
  • For security vulnerabilities, please see the Security policy

Pull request guidelines

To contribute code changes, follow the standard GitHub pull request workflow:

  1. Fork the repository.
  2. Create a new branch for your work.
  3. Make whatever changes you need — small or large — and use commit messages that briefly describe the intent.

  4. If documentation updates are required, open a second PR in the ovi-docs repository.
    Reference the code PR in the docs PR, and the docs PR in the code PR. You may reference the PRs in a comment

  5. Open a pull request against the main branch.

A good PR includes:

  • A clear description of the problem and the proposed solution.
  • Any setup or testing steps required to verify the change.
  • References to related issues, if applicable.

License agreement

By contributing to this project, you agree that your contributions will be licensed under the Apache License 2.0.

By contributing to the documentation, you agree that your contributions will be licensed under CC BY-SA 4.0.

Thank you for helping improve ovi!