Skip to content

Commit

Permalink
docs(bug triage): add a doc about bug triaging procedures (spinnaker#113
Browse files Browse the repository at this point in the history
)

* docs(bug triage): add a doc about bug triaging procedures

* Apply suggestions from code review

Co-Authored-By: Rob Zienert <[email protected]>
Co-Authored-By: Matt Duftler <[email protected]>

* More comments from code reviews.

* Make sample messages copy/pastable.

* Clarify the beginner friendly label a little more

* Apply suggestions from code review

Co-Authored-By: Dave Dorbin <[email protected]>

* remove 'should'

* clean up a few small things from dorbin's patches

* run mdformat

* indent a hanging paragraph properly

Co-authored-by: Rob Zienert <[email protected]>
Co-authored-by: Matt Duftler <[email protected]>
Co-authored-by: Dave Dorbin <[email protected]>
  • Loading branch information
4 people authored Apr 14, 2020
1 parent 03e55c7 commit b9ff4e4
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions sig-bug-triage-process.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
## SIG Bug Triage Process

SIGs will triage the issues with their matching label during every SIG meeting.
You can view
[a list of recently filed issues](https://github.com/spinnaker/spinnaker/labels/sig%2Fplatform)
on GitHub to click through the ones filed since your last meeting. (That link
shows issues for the Platform SIG, but you can easily edit the filter from
there.)

At the end of the SIG meeting, each issue will have one of three outcomes:

1. **Assigned to a user or added to an actively-maintained GitHub project.** An
actively-maintained project has a team of people who are using it to plan
future work.

1. **Marked with the label "contributions welcome".** This is an indicator that
we don't know anyone who will be working on the issue, but we would be
interested in discussing it further if a contributor could be found. Please
also add a message to the issue describing the situation:

> Thanks for filing the issue. Unfortunately, no one is available to work on
> this at the moment, but we welcome contributions from our community. We
> strongly encourage you to discuss your plans here or on the SIG's \[slack
> channel](https://join.spinnaker.io/) before you start working on the
> issue.
By default, each issue is closed automatically after enough time passes with
no one available to fix it. If the issue needs to remain open, add the
`no-lifecycle` tag, which prevents it from being closed. Add the tag
`beginner friendly` if it looks like an issue that a new contributor could
help with, which will also prevent it from being automatically closed.

1. **Closed.** There are a few reasons why you might close a bug.

If it appears to be a request for support and not a genuine bug, please
close it with a message like this:

> Thanks for filing this issue. It looks like this might be a request for
> help rather than a bug. In that case, you're probably better off looking
> for answers \[from our Slack community](https://join.spinnaker.io/), since
> there is a larger pool of users there. Use the search functionality to
> find users who have a similar experience, or post a message in \`#general`
> or another related channel.
Alternately, this might be a bug with no reproduction steps and not enough
details to warrant a proper investigation. In that case, consider a response
like the following:

> Thanks for filing the issue. We can't determine the cause of the issue
> without steps to reproduce, nor are we able to recreate it ourselves.
> Unfortunately, this means we have to close the issue. Please reopen it
> with some steps to reproduce if you can.
There will undoubtedly be other reasons to close an issue, but please leave
a message when you do. Closing a bug with a message is a much friendlier
experience than having it automatically closed by Spinnakerbot months later.

0 comments on commit b9ff4e4

Please sign in to comment.