Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

43 lines (31 loc) · 1.82 KB

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

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

Second, before starting on a project that you intend to contribute in any form, we strongly recommend posting on our Issues page and briefly outline the changes you plan to make. This will enable us to provide some context that may be helpful for you. This could range from advice and feedback on how to optimally perform your changes or reasons for not doing it.

Lastly, if you're looking for input on what to contribute browse the GitHub issues, especially ones with the help wanted or good first issue label.

Git Branches

The main branch corresponds to the most recent version of the project. Note that this branch may be unstable and may be newer that the latest release.

When contributing to the project, please make sure that your Pull Request (PR) contains the following:

  • Detailed description of the changes performed
  • Corresponding changes to documentation, changelog and unit tests
  • Summary of the tests performed to validate your changes
  • Issue numbers that the PR resolves (if any)

Contributor License Agreements

When you open a pull request, you will be asked to acknolwedge 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.