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.

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

Refine bug reporting guidance documentation #590

Closed
4 tasks
Tracked by #629 ...
jmcook1186 opened this issue Apr 9, 2024 · 3 comments
Closed
4 tasks
Tracked by #629 ...

Refine bug reporting guidance documentation #590

jmcook1186 opened this issue Apr 9, 2024 · 3 comments
Assignees

Comments

@jmcook1186
Copy link
Contributor

jmcook1186 commented Apr 9, 2024

Sub of #651

What
Update the contribution guidelines in our main repository and docs website to help users report bugs effectively.

Why
As a core dev I want our users to submit bug reports in a standard format so we can triage it effectively and apply our decision making process consistently.

As a user, I want a clear explanation of what's expected when I report a bug so I can be confident it will be handled effectively.

We can make our bug response much more efficient and effective by clearly communicating to users what information we need to reproduce, diagnose and fix bugs. If users conform to our standard, we will be able to handle them in our triage calls without requiring lots of back and forth async discussion with the user. We are updating our bug report template in a separate ticket and this issue adds explicit guidance on how to fill out the template to our contribution documentation in the IF repository and our docs website to make sure users can provide us the information we need to address their issues efficiently and effectively.

NOTION LINKS:

Statement of Work

  • Write up guidance documentation for filling out our new bug report template on if/contributing.md
    - [ ] Write up guidance documentation for filling out our new bug report template on the contributing page at if.greensoftware.foundation(one source of truth)
  • Change if contributions documentation to point to if/contributing.md

Prerequisites

#586 must be completed first

Acceptance criteria

Deadline
tbc

Reviewer*

@jawache
Copy link
Contributor

jawache commented Apr 16, 2024

@jmcook1186 is there a strong reason to keep this separate from #586? The guidance and template would be done hand in hand I'd have the same conversations on both tickets. To me it makes sense to merge into one, it's all going to be done by the same person anyway and one is immediately after the other.

@jmcook1186
Copy link
Contributor Author

Sure, they can be combined. I'll close this and add there.

@zanete
Copy link

zanete commented Apr 22, 2024

Closing as per above conversation

@zanete zanete closed this as not planned Won't fix, can't repro, duplicate, stale Apr 22, 2024
@github-project-automation github-project-automation bot moved this from Backlog to Done in IF Apr 22, 2024
@zanete zanete mentioned this issue Apr 22, 2024
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

3 participants