|
@@ -1,28 +1,29 @@
|
|
|
## How to contribute?
|
|
## 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.
|
|
|
|
|
|
|
+Everyone is welcome to contribute to bgfx through bug reports, testing on
|
|
|
|
|
+various 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 code, assisting
|
|
|
|
|
+newcomers, or promoting the project.
|
|
|
|
|
|
|
|
-If you have just quick oneliner question it's preferable to ask it at chat
|
|
|
|
|
-https://discord.gg/9eMbv7J instead opening new issue.
|
|
|
|
|
|
|
+For quick one-liner questions, use the chat at https://discord.gg/9eMbv7J
|
|
|
|
|
+instead of opening an issue.
|
|
|
|
|
|
|
|
-## Submitting bugs
|
|
|
|
|
|
|
+## 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.
|
|
|
|
|
|
|
+For non-trivial bugs, provide a reproducible case by modifying an existing
|
|
|
|
|
+example with minimal changes to demonstrate the issue—this speeds up fixes.
|
|
|
|
|
|
|
|
-## Contributing code
|
|
|
|
|
|
|
+## Contributing Code
|
|
|
|
|
|
|
|
-**When contributing to the bgfx project you must agree to the BSD 2-clause
|
|
|
|
|
-licensing terms.**
|
|
|
|
|
|
|
+**By contributing to bgfx, you agree to the BSD 2-Clause License terms.**
|
|
|
|
|
|
|
|
Pull request checklist:
|
|
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.
|
|
|
|
|
|
|
+ - Test your code with the provided examples before submitting.
|
|
|
|
|
+ - Keep PRs focused with minimal changes relevant to the feature or fix.
|
|
|
|
|
+ - Use [EditorConfig](http://editorconfig.org/) to match the project's editor
|
|
|
|
|
+ settings.
|
|
|
|
|
+
|
|
|
|
|
+## Sponsoring the Project
|
|
|
|
|
+
|
|
|
|
|
+Support bgfx development by using GitHub Sponsors at https://github.com/sponsors/bkaradzic.
|