28 lines
1.0 KiB
Markdown
28 lines
1.0 KiB
Markdown
|
## How to contribute?
|
||
|
|
|
||
|
|
Everyone is welcome to contribute to bgfx by submitting bug reports, testing on
|
||
|
|
different platforms, writing examples, 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://gitter.im/bkaradzic/bgfx 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.
|