Skip to content
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.

Sign up for GitHub

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

Update Contributing guide with opening a bug step ♻️ #885

Merged
merged 4 commits into from
Jan 10, 2023
Merged

Update Contributing guide with opening a bug step ♻️ #885

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
46202e1
Update Contributing guide with opening a bug stpe
pictos Jan 9, 2023
df4da59
added a field on bug report template asking the member to read our gu…
pictos Jan 9, 2023
326f85f
Update CONTRIBUTING.md
pictos Jan 10, 2023
c9fae01
Update .github/ISSUE_TEMPLATE/bug_report_template.yml
pictos Jan 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_template.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
pictos marked this conversation as resolved.
Show resolved Hide resolved
options:
- label: I have read the "Reporting a bug" section on Contributing file.
required: true
- type: textarea
attributes:
label: Current Behavior
Expand Down
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
pictos marked this conversation as resolved.
Show resolved Hide resolved

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
Expand Down