Arseny Kapoulkine
e6f65c8dd1
Add a section to contributing guide regarding the agreement to distribute the code under the terms of MIT license and transfer various rights to the project maintainer. Prior art (using the same language): - https://github.com/baldurk/renderdoc/blob/v1.x/docs/CONTRIBUTING.md#copyright--contributor-license-agreement - https://github.com/ocornut/imgui/blob/master/docs/CONTRIBUTING.md#copyright--contributor-license-agreement This change naturally does not retroactively affect existing contributions (although GitHub terms of service already establishes this partially); the vast majority of the code is written by the project author anyway. There are no future plans to relicense the project or do anything else that affects the users of the project in any way. This change, however, sets the project up for consistent ownership and allows companies to sponsor development of the project via contracts without the code written as part of that being owned by the sponsor.
4.6 KiB
Thanks for deciding to contribute to meshoptimizer! These guidelines will try to help make the process painless and efficient.
Questions
If you have a question regarding the library usage, please open a GitHub issue. Some questions just need answers, but it's nice to keep them for future reference in case other people want to know the same thing. Some questions help improve the library interface or documentation by inspiring future changes.
Bugs
If the library doesn't compile on your system, compiles with warnings, doesn't seem to run correctly for your input data or if anything else is amiss, please open a GitHub issue. It helps if you note the version of the library this issue happens in, the version of your compiler for compilation issues, and a reproduction case for runtime bugs.
Of course, feel free to create a pull request to fix the bug yourself.
Features
New algorithms and improvements to existing algorithms are always welcome; you can open an issue or make the change yourself and submit a pull request.
For major features, consider opening an issue describing an improvement you'd like to see or make before opening a pull request. This will give us a chance to discuss the idea before implementing it - some algorithms may not be easy to integrate into existing programs, may not be robust to arbitrary meshes or may be expensive to run or implement/maintain, so a discussion helps make sure these don't block the algorithm development.
Code style
Contributions to this project are expected to follow the existing code style.
.clang-format file mostly defines syntactic styling rules (you can run make format to format the code accordingly).
As for naming conventions, this library uses snake_case for variables, lowerCamelCase for functions, UpperCamelCase for types, kCamelCase for global constants and SCARY_CASE for macros. All public functions/types must additionally have an extra meshopt_ prefix to avoid symbol conflicts.
Dependencies
Please note that this library uses C89 interface for all APIs and a C++98 implementation - C++11 features can not be used. This choice is made to maximize compatibility to make sure that any toolchain, including legacy proprietary gaming console toolchains, can compile this code.
Additionally, the library code has zero external dependencies, does not depend on STL and does not use RTTI or exceptions. This, again, maximizes compatibility and makes sure the library can be used in environments where STL use is discouraged or prohibited, as well as maximizing runtime performance and minimizing compilation times.
The demo program uses STL since it serves as an example of usage and as a test harness, not as production-ready code.
Testing
All pull requests will run through a continuous integration pipeline using GitHub Actions that will run the built-in unit tests and integration tests on Windows, macOS and Linux with gcc, clang and msvc compilers.
You can run the tests yourself using make test or building the demo program with cmake -DBUILD_DEMO=ON and running it.
Unit tests can be found in demo/tests.cpp and functional tests - in demo/main.cpp; when making code changes please try to make sure they are covered by an existing test or add a new test accordingly.
Documentation
Documentation for this library resides in the meshoptimizer.h header, with examples as part of a usage manual available in README.md.
Changes to documentation are always welcome and should use issues/pull requests as outlined above; please note that README.md only contains documentation for stable algorithms, as experimental algorithms may change the interface without concern for backwards compatibility.
Sensitive communication
If you prefer to not disclose the issues or information relevant to the issue such as reproduction case to the public, you can always contact the author via e-mail (arseny.kapoulkine@gmail.com).
Contributor agreement
Any code you submit will become part of the repository and be distributed under the meshoptimizer license. By submitting code to the project you agree that the code is your work and that you can give it to the project.
You also agree by submitting your code that you grant all transferrable rights to the code to the project maintainer, including for example re-licensing the code, modifying the code, and distributing it in source or binary forms. Specifically, this includes a requirement that you assign copyright to the project maintainer.