✏️Contribution Guidelines

Thank you for considering contributing to the OVRTK repository! We appreciate your interest in helping us improve our project. Please take a moment to review the guidelines below before you get started.

Table of Contents

1. Getting Started

2. Code of Conduct

3. How to Contribute

4. Reporting Bugs

5. Feature Requests

6. Pull Request Guidelines

Getting Started

• If you are new to Git and GitHub, make sure to check out the GitHub Guides to get started with the basics.

• Make sure you have a GitHub account.

• Fork the OVRTK repository to your own GitHub account.

• Clone your fork to your local development environment:

  git clone https://github.com/YourUsername/OVRTK.git
  cd OVRTK

• Set up the project according to the instructions.

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please read it before making any contributions.

How to Contribute

1. Check the issue tracker for existing issues or feature requests that you may be interested in.

2. If you plan to work on an issue, please comment on it to let others know.

3. If you have a new idea or find a bug not listed in the issue tracker, create a new issue describing it.

4. Fork the repository, create a branch for your contribution, and start working on it.

5. Make sure to follow the coding standards and guidelines (see below).

6. When your contribution is ready, submit a pull request to the main repository. Please reference the issue number in your pull request.

7. Your pull request will be reviewed by maintainers, and you may be asked to make changes if necessary.

Reporting Bugs

To report a bug or issue, please follow these guidelines:

1. Search the issue tracker to see if the issue has already been reported.

2. If not, create a new issue and include:

   • A clear and concise title.

   • A detailed description of the issue.

   • Steps to reproduce the issue if applicable.

   • Information about your environment (OS, browser, etc.).

Feature Requests

If you have a feature request, follow these steps:

1. Search the issue tracker to see if the feature request has already been submitted.

2. If not, create a new issue and include:

   • A clear and concise title.

   • A detailed description of the requested feature.

   • Justification for the feature (why it's needed).

Pull Request Guidelines

When submitting a pull request, please follow these guidelines:

1. Create a new branch for your feature/fix, e.g., feature/new-feature or fix/issue-123.

2. Write clear and concise commit messages.

3. Keep your codebase clean and ensure it passes any existing tests.

4. Make sure your pull request is up to date with the latest changes from the main repository.

5. Reference the issue number in your pull request description, e.g., "Closes #123."