Contributing

Thank you for your interest in contributing to glTFast! We are incredibly excited to see how members of our community will use and extend glTFast. To facilitate your contributions, we've outlined a brief set of guidelines to ensure that your extensions can be easily integrated.

Communication

Please read through our code of conduct, as we expect all our contributors to follow it.

Contact

For inquiries of all sorts there are ways to get in touch with the glTFast maintainers.

Contribution Ideas

If you're looking for ideas on ways to contribute browse the issues, especially ones with the help wanted or good first issue label.

Preparation

Before starting to work on a contribution we recommend searching within the existing issues and pull requests for similar topics to avoid redundant efforts and make sure you got all contextual information.

Feel free to propose ideas upfront via an issue that briefly outlines your intended changes. We'll then try to give you advice and feedback on how to optimally implement those changes or, if justifiable, reasons to abandon an idea. This pre-evaluation can raise the chances of getting a contribution accepted.

Version Control

glTFast uses Git and GitHub for version control.

Submission via Pull Request

Changes can be proposed via pull requests (PR) on the pull requests page.

In order to get a positive review and increase the chances getting a PR merged, make sure the PR has the following traits.

  • Concise title.
  • Detailed description of the proposed improvements.
  • Testing
    • All existing tests pass.
    • Added or modified code is covered by tests. Add new tests if needed.
  • Changelog entry.
  • Updates and additions to documentation, if applicable.
  • References to issues that the PR resolves, if any.
  • Contributor License Agreements signed by all authors.

PRs will be transferred to an internal, mirrored repository to undergo review and (automated) tests that use Unity® internal tools and infrastructure. If those tests and reviews are not successful, we'll try to help you resolving remaining issues. Once all problems are resolved, the actual merge will happen on the mirrored repository and the original pull requests will get closed with a proper notification about expected release version and date.

Contributor License Agreements

When you open a pull request, you will be asked to acknowledge our Contributor License Agreement. You will have to confirm that your Contributions are your original creation and that you have complete right and authority to make your contributions. We allow both individual contributions and contributions made on behalf of companies.

Trademarks

Unity® is a registered trademark of Unity Technologies.