bgfx/CONTRIBUTING.md

29 lines
1.2 KiB
Markdown

## How to contribute?
Everyone is welcome to contribute to bgfx by submitting bug reports, testing on
different platforms, writing examples (see [Help Needed](https://github.com/bkaradzic/bgfx/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+needed%22)
for ideas), improving documentation, profiling and optimizing, helping
newcomers, telling others about bgfx, etc.
If you have just quick oneliner question it's prefereable to ask it at chat
https://discord.gg/9eMbv7J instead opening new issue.
## Submitting bugs
Unless bug is trivial, and easy to explain and understand, the fastest way to
fix bug is to get repro case. In most of cases it's enough to modify existing
example (with minimal number of changes) and reproduce bug there.
## Contributing code
**When contributing to the bgfx project you must agree to the BSD 2-clause
licensing terms.**
Pull request checklist:
- Make sure you test your code with provided examples before creating PR.
- Create focused PR with minimal number of changes relevant to feature added
or bug fixed.
- Use [EditorConfig](http://editorconfig.org/) in your editor of choice to
apply the same editor settings used by bgfx project.