You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
@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.
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
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)if/contributing.md
Prerequisites
#586 must be completed first
Acceptance criteria
Deadline
tbc
Reviewer*
The text was updated successfully, but these errors were encountered: