Mirrors/bgfx
1
0
Fork 0
mirror of https://github.com/bkaradzic/bgfx.git synced 2026-02-17 12:42:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated contributing.

Browse Source
This commit is contained in:
Бранимир Караџић
2025-11-03 06:30:05 -08:00
parent e113d598ae
commit accf0ab417
1 changed files with 19 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
CONTRIBUTING.md
View File

@@ -1,28 +1,29 @@
## How to contribute? ## How to contribute?
Everyone is welcome to contribute to bgfx by submitting bug reports, testing on Everyone is welcome to contribute to bgfx through 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) 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, helping for ideas), improving documentation, profiling and optimizing code, assisting
newcomers, telling others about bgfx, etc. newcomers, or promoting the project.
If you have just quick oneliner question it's preferable to ask it at chat For quick one-liner questions, use the chat at https://discord.gg/9eMbv7J
https://discord.gg/9eMbv7J instead opening new issue. instead of opening an issue.
## Submitting bugs ## Submitting Bugs
Unless bug is trivial, and easy to explain and understand, the fastest way to For non-trivial bugs, provide a reproducible case by modifying an existing
fix bug is to get repro case. In most of cases it's enough to modify existing example with minimal changes to demonstrate the issue—this speeds up fixes.
example (with minimal number of changes) and reproduce bug there.
## Contributing code ## Contributing Code
**When contributing to the bgfx project you must agree to the BSD 2-clause **By contributing to bgfx, you agree to the BSD 2-Clause License terms.**
licensing terms.**
Pull request checklist: Pull request checklist:
- Make sure you test your code with provided examples before creating PR. - Test your code with the provided examples before submitting.
- Create focused PR with minimal number of changes relevant to feature added - Keep PRs focused with minimal changes relevant to the feature or fix.
or bug fixed. - Use [EditorConfig](http://editorconfig.org/) to match the project's editor
- Use [EditorConfig](http://editorconfig.org/) in your editor of choice to settings.
apply the same editor settings used by bgfx project.
## Sponsoring the Project
Support bgfx development by using GitHub Sponsors at https://github.com/sponsors/bkaradzic.