Skip to content

Commit

Permalink
chore: add more label-actions for bugs (#29931)
Browse files Browse the repository at this point in the history
Co-authored-by: HonkingGoose <[email protected]>
  • Loading branch information
rarkins and HonkingGoose committed Jul 1, 2024
1 parent 0208d76 commit c5eee75
Show file tree
Hide file tree
Showing 2 changed files with 178 additions and 0 deletions.
100 changes: 100 additions & 0 deletions .github/label-actions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,25 @@
The Renovate team
'auto:logs-packages':
comment: >
Hi there,
Please give us specific logs, so we can help you more.
If you self-host Renovate: make sure you run Renovate with `LOG_LEVEL=debug` to get the debug log messages! Next, open the debug-level logs and search for `packageFiles with updates`. This text marks the start of a structured log message that shows every package file, dependency, and update that Renovate found.
Find the relevant dependency/dependencies in the log message, and copy/paste those parts into this discussion. If you do not know which bits we need, you can copy/paste the full log message.
Read the [Renovate docs, Troubleshooting](https://docs.renovatebot.com/troubleshooting/) to learn more about getting the docs, and getting the correct type of logs.
Thanks, the Renovate team
'new package manager':
comment: >
Hi there,
Expand Down Expand Up @@ -338,4 +357,85 @@
As a general rule, we will read and respond to all discussions in this repository, so there is no need to mention us.
Thanks, the Renovate team
'auto:bug-to-idea':
comment: >
Hi there,
A maintainer reviewed the information, and decided that this is not a bug. To avoid confusing others, we will close this Discussion. Please keep reading as there is good news too!
The good news is that the maintainer likes your idea, in general. Please create a new [Suggest an Idea](https://github.com/renovatebot/renovate/discussions/new?category=suggest-an-idea) Discussion. Feel free to copy/paste what you need from this Discussion. Please focus on the feature request: explain what Renovate should do, and how Renovate can know when/what to do. We may convert that Discussion to an Issue when it is ready. Note that you will still have to wait for a maintainer, or someone else, to do the work needed for your feature.
Why are we closing your Discussion? For us, bug reports are about things that are not working as intended, or things that are not working as described in the docs. What you found may be bad behavior, but we do not think it is a bug.
For more details, please read [our development docs about bug handling](https://github.com/renovatebot/renovate/blob/main/docs/development/bug-handling.md).
Thanks, the Renovate team
'auto:bug-invalid':
comment: >
Hi there,
A maintainer decided this is not a bug, and behaving as designed. The maintainer will explain why this behavior is correct. To avoid confusing future readers, we will close this Discussion.
We want Bug-type Discussions to be about things that we rate as bugs. For more details, please read [our development docs about bug handling](https://github.com/renovatebot/renovate/blob/main/docs/development/bug-handling.md).
If this bug report makes you think of an idea for a new feature, or how to improve a current feature, feel free to create a new [Suggest an Idea](https://github.com/renovatebot/renovate/discussions/new?category=suggest-an-idea) Discussion.
Thanks, the Renovate team
'auto:bug-converted':
comment: >
Hi there,
A maintainer confirmed this is a bug, and converted this Discussion to an Issue. If you have more thoughts/info about the bug, please post them in the Issue.
We will close this Discussion, as we want new info to go in the Issue.
Thanks, the Renovate team
'auto:idea-rewrite':
comment: >
Hi there,
The maintainers want to convert this idea into a Feature Request issue. Before we can convert, we need you update the Discussion title and/or the description(s).
We want the top post, and title, to match the current state of your idea/feature request. This is because a discussion often has lots of info, thoughts and comments. There may also be ideas that turn out to be dead ends. In simple terms, we only want the good stuff to go in the top post.
So please put the current information in the top post and update the title. Feel free to copy/paste examples, links or comments into the description. Let us know when you are finished updating, and we will convert your discussion to an Issue.
Thanks, the Renovate team
'auto:no-slas':
comment: >
Hi there,
Please remember that there are no Service Level Agreements (SLAs) or roadmap commitments in Open Source projects like Renovate. The maintainers and contributors work on bugs/features/docs at their own pace. This means that sometimes you will have to wait for things to happen, or to get a response.
Please avoid comments like: "Any update on this?" or "When will this be fixed?". Do not chase a maintainer to get answers quickly. We will block you if you nudge us frequently.
Please read our [Code of Conduct, how we prioritize work](https://github.com/renovatebot/renovate/blob/main/CODE_OF_CONDUCT.md#how-we-prioritize-work) to learn more about how we prioritize what to work on.
If you are a paying Mend.io customer, please tell your support or customer contact that this issue is important to you.
Thanks, the Renovate team
78 changes: 78 additions & 0 deletions docs/development/bug-handling.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Bug report handling

## Start with a Discussion

We use GitHub Discussions as a triaging stage for bug reports.
Users should [create a new Request Help discussion](https://github.com/renovatebot/renovate/discussions/new?category=request-help) and choose from the options there.

We often need more information to resolve your bug report.
Maintainers may ask for such information directly, or use automated label comments, or both.
Maintainers may close bug reports that lack the extra information, for example when keeping the Discussion open does not help other users anymore.

We only create issues in this repository when we:

- consider them to be actionable
- are in a state where someone could work on it

We often need a minimal reproduction or logs, or even _both_, to pinpoint the exact problem.
Because we need enough information for a actionable bug report, we may close Discussions that lack the needed info, even if it's highly likely the behavior is buggy.

We have found that keeping Issues around that are not actionable just leads to them getting stale, and then closed.
The Issues list is meant as a list of actionable things for a contributor or maintainer to pick up eventually.

## Discussion Resolution

Bug reports are resolved in one of three ways:

1. Confirmed as a bug. The Discussion will be converted to an Issue, and then closed. Any future comments go to the Issue and _not_ the Discussion.
1. Closed as "behaving as designed" with no further action. The Discussion will be closed with a relevant note.
1. Rejected as not a _bug_, but accepted as a _feature request_. The Discussion will be closed with a note suggesting that the poster create a new "Suggest an Idea" Discussion instead, which can then be converted to an Issue once actionable.

## FAQ

### What's your definition of bug?

Bugs are behavior in Renovate which is _not_ as intended or documented.
Missing functionality or partial support is not automatically a bug.
For example, we're probably missing at least one feature from each package manager that Renovate supports.
If we labeled all those missing features as bugs, we lose sight of real bugs.

### Why can't I create Bug Issues directly?

It is really hard for users to decide if something is a bug.
Only a fraction of the incoming bug reports are for things we consider proper bugs.

A while ago, users were allowed to create Bug Issues.
We ended up with many "bug, but not really" type issues, that polluted the repository.
Those issues made it tricky for maintainers and users to see what's really going on in the repository.
We have since closed many old user-created bug Issues, and now only allow maintainers to create bug Issues.
This way we do not end up in the same situation again.

### What if I disagree with your definition of bug?

We are not interested in debating you, we prefer to spend our time helping users solve their problems.
We are open to improve our approach to bugs, or this document, in good spirit.
Please do _not_ post comments like these:

- "How dare you block users from creating Issues?!"
- "If the behavior was unexpected to me then that means it's a bug."

Users who want to make our life difficult as maintainers will be blocked.
Read our [Code of Conduct](https://github.com/renovatebot/renovate/blob/main/CODE_OF_CONDUCT.md) to learn more.

### Why do you close Bug discussions?

It's important to move relevant reports to the next step of an Issue, and focus our attention there.
Bug reports that are not (going to be) an Issue, are marked as "not a bug".
This helps future users who browse or search the repository for similar terms, as they will not see any invalid Bug reports.

If you are not sure if you have an _actual_ bug to report, please use the "Request Help" Discussion category.

### When will you fix my bug?

There are no Service Level Agreements (SLAs) in Open Source.
This means we are not required to respond to, or fix your problem within a certain time.

If you are a paying Mend.io customer, please tell your support or customer contact that this bug is important to you.

Please read our [Code of Conduct, how we prioritize work](https://github.com/renovatebot/renovate/blob/main/CODE_OF_CONDUCT.md#how-we-prioritize-work) to learn more.

0 comments on commit c5eee75

Please sign in to comment.