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

Jump to bottom

updated bug reporting document to reflect the changes in the templates. #3445

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

updated bug reporting document to reflect the changes in the templates. #3445

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 6 additions & 9 deletions docs/bug_reporting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
# Internal Bug Reporting
# Bug Reporting

Bugs reported internally usually come from three test flows/streams:
As summary, when you find a bug for WGE:

1) Bugs reported during the Acceptance Testing of a new feature/story. And by Acceptance Testing we mean manually testing a new feature to verify that it complies with the acceptance criteria, design, and behaves as expected before merging this feature into `main`. Those bugs are labeled with `bug_acceptance`. For reporting those bugs, `Acceptance Testing Bug Report` issue template can be used.
1. Raise a [new bug](https://github.com/weaveworks/weave-gitops-enterprise/issues/new/choose) via [`bug`](../.github/ISSUE_TEMPLATE/bug.md) issue template.
2. Fill-in the details about the bug, expected behaviour, etc ... Use the comments in the template to guide you through.
3. Once submitted, it will be labelled for [team/product-management](https://github.com/orgs/weaveworks/teams/product-management) to triage.
4. Follow the progress and / or interact via comments.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@weaveworks/product-management :

  1. what do you think about the steps here for bug issues created directly in this repo?
  2. would be labelling enough for us to take over or we want to get them assigned to us?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's fair to say that we automatically tag them as "pending" or something, and that way we can review "pending" issues and decide what to do with them?


2) Bugs reported during any regular testing or regression testing of `main`. Those bugs are labeled with `bug_regression`. For reporting those bugs, `Bug Report` issue template can be used.

3) Bugs reported during testing a released version. Those bugs are labeled with `bug_release`. For reporting those bugs, `Bug Report` issue template can be used.


Both issue templates are created by default with the label `team/pesto` attached to them. Make sure to add your team's label instead if the bug is within one of the domains handled by your team.
Loading