-
-
Notifications
You must be signed in to change notification settings - Fork 10.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
How to open an Issue or Pull Request #2261
Comments
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Moved this to https://github.com/ocornut/imgui/blob/master/docs/CONTRIBUTING.md
Hello!
You may use the Issue Tracker to submit bug reports, feature requests or suggestions. You may ask for help or advice as well. However, please carefully read this wall of text before doing so.
PLEASE CAREFULLY READ THIS WALL OF TEXT.
ISSUES IGNORING THOSE GUIDELINES MAY BE CLOSED.
USERS IGNORING THOSE GUIDELINES MIGHT BE BLOCKED.
Please do your best to clarify your request. The amount of incomplete or ambiguous requests due to people not following those guidelines is often overwhelming. Issues created without the requested information may be closed prematurely. Exceptionally entitled, impolite or lazy requests may lead to bans.
PLEASE UNDERSTAND THAT OPEN-SOURCE SOFTWARE LIVES OR DIES BY THE AMOUNT OF ENERGY MAINTAINERS CAN SPARE. WE HAVE LOTS OF STUFF TO DO. THIS IS AN ATTENTION ECONOMY AND MANY LAZY OR MINOR ISSUES ARE HOGGING OUR ATTENTION AND DRAINING ENERGY, TAKING US AWAY FROM MORE IMPORTANT WORK.
Thank you!
Getting Started?
If you are Getting Started with Dear ImGui and:
Then please use the Discussions forums.
If Dear ImGui is successfully showing in your app and you have used Dear ImGui before, you can open an Issue.
How to open an Issue
Prerequisites for new users of dear imgui
ImGui::ShowDemoWindow()
to explore the demo and its sources.Guidelines to report an issue or ask a question
IM_ASSERT(false);
in your main() function. Your application should display an error message and abort. If your application doesn't report an error, your asserts are disabled.Some unfortunate words of warning
If you have been using dear imgui for a while or have been using C/C++ for several years or have demonstrated good behavior here, it is ok to not fullfill every item to the letter. Those are guidelines and experienced users or members of the community will know which information are useful in a given context.
How to create a Pull Request
local_variable
,FunctionName()
,MemberName
,// Text Comment
,//CodeComment();
, C-style casts, etc.. We don't use modern C++ idioms and tend to use only a minimum of C++11 features. The applications under examples/ are generally less consistent because they sometimes try to mimic the coding style often adopted by a certain ecosystem (e.g. DirectX-related code tend to use the style of their sample).Thank you for reading!
The text was updated successfully, but these errors were encountered: