Contributing to glam

Thanks for contributing to glam! These guidelines will try to make the process painless and efficient.

The short guide to contributing is start a discussion on GitHub. Pull requests are welcome for bug fixes, documentation improvements and optimizations. For anything else it would be best to discuss it first.

Questions

If you have a question about the usage of this library please ask a question with GitHub Discussions. That's the easiest way to get support right now.

Bugs

If you find a bug please open an issue on GitHub or submit a pull request. A unit test for any bug that slipped through existing coverage would also be greatly appreciated.

New functions and methods

If glam is missing functionality on existing types, suggest a new feature with GitHub Discussions describing what feature you would like added and ideally what your use case is for it just so I have a better understanding of the feature. I'd like to keep glam reasonably light functionality wise initially but commonly used functionality that is missing is very welcome. If you do submit a pull request please ensure any new functionality also has a test.

Optimizations

If you feel some functionality could be optimized please open an issue on GitHub or submit a pull request. Any optimization pull request should include a benchmark if there isn't one already, so I can confirm the performance improvement.

Documentation

If you feel any documentation could be added or improved please [open a GitHub issue] or submit a pull request.

Code contributions

Most of glam's source code is generated. See the codegen README on how to modify the code templates and generate new source code.

Edit templates in the templates/ directory (they use the Tera v2 templating language) and the codegen.json file which maps templates to output files. After modifying templates, run cargo run --release -p codegen from the repo root to regenerate source files (requires initializing the codegen submodule with git submodule update --init tools/codegen).

You can run glam's test suite locally by running cargo run -p ci. It's worth running that before creating a PR.

Also run cargo fmt and cargo clippy on any new code.