mirror of
https://github.com/ocornut/imgui.git
synced 2026-01-11 00:04:24 +00:00
Docs: various updates, rewording, clarifying the purpose of a PR.
This commit is contained in:
parent
65dac02171
commit
1a6ec208cc
3 changed files with 31 additions and 17 deletions
1
.github/CONTRIBUTING.md
vendored
1
.github/CONTRIBUTING.md
vendored
|
|
@ -33,6 +33,7 @@ You may use the Issue Tracker to submit bug reports, feature requests or suggest
|
|||
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 an Pull Request
|
||||
- Please understand that by submitting a PR you are also submitting a request for the maintainer to review your code and then take over its maintenance forever. PR should be crafted both in the interest in the end-users and also to ease the maintainer into understanding and accepting it.
|
||||
- When adding a feature, please describe the usage context (how you intend to use it, why you need it, etc.).
|
||||
- When fixing a warning or compilation problem, please post the compiler log and specify the version and OS you are using.
|
||||
- Try to attach screenshots to clarify the context and demonstrate the feature at a glance. You can drag pictures/files here (prefer github attachments over 3rd party hosting).
|
||||
|
|
|
|||
1
.github/pull_request_template.md
vendored
1
.github/pull_request_template.md
vendored
|
|
@ -1,4 +1,5 @@
|
|||
- Please read https://github.com/ocornut/imgui/blob/master/.github/CONTRIBUTING.md
|
||||
- Please understand that by submitting a PR you are also submitting a request for the maintainer to review your code and then take over its maintenance forever. PR should be crafted both in the interest in the end-users and also to ease the maintainer into understanding and accepting it.
|
||||
- When adding a feature, please describe the usage context (how you intend to use it, why you need it, etc.).
|
||||
- When adding a feature, try to attach screenshots/gifs to clarify the context and demonstrate the feature at a glance.
|
||||
- When fixing a warning or compilation problem, post the compiler log and specify the version and OS you are using.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue