Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 1.51 KB

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

The short guide to contributing is open a github issue. 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 open a github issue. That's the easiest way to get support right now.

Bugs

If you find a bug please open a github issue 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, open a github issue 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 a github issue 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.