From f93a22ae6e7860c4aa928a1e4bbb0d916a9aa69b Mon Sep 17 00:00:00 2001 From: omar Date: Tue, 13 Mar 2018 11:47:57 +0100 Subject: [PATCH] Contributing: tweaks, mention screenshots more prominently. --- .github/CONTRIBUTING.md | 1 + .github/issue_template.md | 2 +- .github/pull_request_template.md | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b4079e0a..05bf73fd 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -25,4 +25,5 @@ If you have been using dear imgui for a while and/or have been using C/C++ for s ## 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? +- Try to attach screenshots to clarify the context and demonstrate the feature at a glance. - 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 958aa165..ae4eb7b5 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -9,4 +9,4 @@ ImGui::ThisIsMoreCode(); ``` For multiline snippets. -(Clear this form before submitting your issue) +(Clear this form before submitting your issue. Please read the CONTRIBUTING.md file!) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 66308e48..1a6418d5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,5 @@ - If you are adding a feature, please explain the context of the change: what do you need the feature for? +- Try to attach screenshots to clarify the context and demonstrate the feature at a glance. - 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.