diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 984ea521d..b4079e0a9 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -22,3 +22,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 and/or have been using C/C++ for several years and/or have demonstrated good behavior here, it is ok to not fullfill every item to the letter. Those are guidelines and experienced users of dear imgui will know what information are useful in a given context. +## How to create an Pull Request + +- If you are adding a feature, please explain the context of the change: what do you need the feature for? +- Make sure you create a branch for the pull request. In Git, 1 PR is associated to 1 branch. If you keep pushing to the same branch after you submitted the PR, your new commits will appear in the PR. diff --git a/.github/issue_template.md b/.github/issue_template.md index e47ef9e89..958aa1653 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -1,7 +1,12 @@ -(Please carefully read guidelines in [CONTRIBUTING.md](https://github.com/ocornut/imgui/blob/master/.github/CONTRIBUTING.md) then delete this line) +You may use the Issue tracker to ask for help, submit bug reports, feature requests or suggestions. +Please carefully read this document before doing so: +[CONTRIBUTING.md](https://github.com/ocornut/imgui/blob/master/.github/CONTRIBUTING.md). -You can include code this way: +You can include code snippets using `Begin()` for short in-line snippets, or: ```cpp ImGui::Begin("Hello"); ImGui::ThisIsMoreCode(); ``` +For multiline snippets. + +(Clear this form before submitting your issue) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..66308e480 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,5 @@ +- If you are adding a feature, please explain the context of the change: what do you need the feature for? +- Make sure you create a branch for the pull request. In Git, 1 PR is associated to 1 branch. If you keep pushing to the same branch after you submitted the PR, your new commits will appear in the PR. +- You can read [CONTRIBUTING.md](https://github.com/ocornut/imgui/blob/master/.github/CONTRIBUTING.md) for more details. + +(Clear this form before submitting your PR)