From 46202e131d2ee4de454292da0d90cda24d05cf9e Mon Sep 17 00:00:00 2001 From: Pedro Jesus Date: Mon, 9 Jan 2023 20:24:43 -0300 Subject: [PATCH 1/4] Update Contributing guide with opening a bug stpe --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d551c7001..05f1f17c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,6 +44,19 @@ We will take appropriate actions and measures if necessary. You will need to complete a Contribution License Agreement before any pull request can be accepted. Complete the CLA at https://cla.dotnetfoundation.org/. This will also be triggered whenever you open a PR and the link should guide you through it. +## Reporting an bug + +If you found something that looks like a bug don't hesitate in opening an issue reporting it. We strongly recommend you to follow our template, if you don't follow your issue can be closed, and that's because we don't have a lot of resources, so we will focus on issues that have most information that we need to work with. And, we would say, the most important part is the reproduction sample that shows the bug. + +### Bug reproduction + +We always request a reproduction sample, and that's not to make your life hard or anything like that... The reason of having a reproduction is to save us time to indentify and fix the bug. Create a new project; download the MCT NuGet; write UI; ViewModel; create a service; run it. As you can see it's a lot of timing consuming for us that we could spend fixing the actual issue. So **PLEASE** create a small reproduction project, upload it on GitHub or GitLab and paste the link in the issue. + +> We don't accept `.zip` files as reproduction samples, for security reasons. So if you send us a `.zip` file we will kindly ask you to upload it to GitHub or GitLab and share the link + +And most important: **Please, help us to help you ❤️** + + ## Opening a PR process ### TL;DR From df4da592103bfaf8b3eb082e1449e2f47b0ff8a1 Mon Sep 17 00:00:00 2001 From: Pedro Jesus Date: Mon, 9 Jan 2023 20:44:01 -0300 Subject: [PATCH 2/4] added a field on bug report template asking the member to read our guidelines --- .github/ISSUE_TEMPLATE/bug_report_template.yml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report_template.yml b/.github/ISSUE_TEMPLATE/bug_report_template.yml index 12f878480..60c992feb 100644 --- a/.github/ISSUE_TEMPLATE/bug_report_template.yml +++ b/.github/ISSUE_TEMPLATE/bug_report_template.yml @@ -10,6 +10,13 @@ body: options: - label: I have searched the existing issues required: true +- type: checkboxes + attributes: + label: Did you read the "Reporting a bug" section on Contributing file? + description: If you don't read, please take a moment to do it and avoid your report being closed. You can find it [here](https://github.com/CommunityToolkit/Maui/blob/main/CONTRIBUTING.md#reporting-an-bug). + options: + - label: I have read the "Reporting a bug" section on Contributing file. + required: true - type: textarea attributes: label: Current Behavior From 326f85fa02484daf6b856f1e12b659984bd670e7 Mon Sep 17 00:00:00 2001 From: Pedro Jesus Date: Mon, 9 Jan 2023 21:18:49 -0300 Subject: [PATCH 3/4] Update CONTRIBUTING.md Co-authored-by: Vladislav Antonyuk <33021114+VladislavAntonyuk@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 05f1f17c6..d77b2e8fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,7 +44,7 @@ We will take appropriate actions and measures if necessary. You will need to complete a Contribution License Agreement before any pull request can be accepted. Complete the CLA at https://cla.dotnetfoundation.org/. This will also be triggered whenever you open a PR and the link should guide you through it. -## Reporting an bug +## Reporting a bug If you found something that looks like a bug don't hesitate in opening an issue reporting it. We strongly recommend you to follow our template, if you don't follow your issue can be closed, and that's because we don't have a lot of resources, so we will focus on issues that have most information that we need to work with. And, we would say, the most important part is the reproduction sample that shows the bug. From c9fae013cd0f2e6b9e42a4baf6038e2a96fadd4f Mon Sep 17 00:00:00 2001 From: Pedro Jesus Date: Mon, 9 Jan 2023 21:18:55 -0300 Subject: [PATCH 4/4] Update .github/ISSUE_TEMPLATE/bug_report_template.yml Co-authored-by: Vladislav Antonyuk <33021114+VladislavAntonyuk@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report_template.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report_template.yml b/.github/ISSUE_TEMPLATE/bug_report_template.yml index 60c992feb..68bbaa61a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report_template.yml +++ b/.github/ISSUE_TEMPLATE/bug_report_template.yml @@ -13,7 +13,8 @@ body: - type: checkboxes attributes: label: Did you read the "Reporting a bug" section on Contributing file? - description: If you don't read, please take a moment to do it and avoid your report being closed. You can find it [here](https://github.com/CommunityToolkit/Maui/blob/main/CONTRIBUTING.md#reporting-an-bug). + description: If you don't read, please take a moment to do it and avoid your report being closed. You can find it at [CONTRIBUTING.md](https://github.com/CommunityToolkit/Maui/blob/main/CONTRIBUTING.md#reporting-a-bug). + options: - label: I have read the "Reporting a bug" section on Contributing file. required: true