docs: Add triaging docs #12605
docs: Add triaging docs #12605
Conversation
mydea
requested review from
stephanie-anderson,
lforst,
AbhiPrasad,
chargome,
s1gr1d and
andreiborza
| Note that issues created by contributors themselves will not get this label applied. They will also not be added to the | ||
| "Web SDK Frontend" board automatically. You'll have to add the "Web SDK Frontend" project manually to issues you create | ||
| yourself as a contributor. |
There was a problem hiding this comment.
L: This seems a bit hard to read. Maybe restructure it a little bit?
| Note that issues created by contributors themselves will not get this label applied. They will also not be added to the | |
| "Web SDK Frontend" board automatically. You'll have to add the "Web SDK Frontend" project manually to issues you create | |
| yourself as a contributor. | |
| **Note for Contributors:** Note that issues created by contributors will not get this label applied. The issues will also not be added to the | |
| "Web SDK Frontend" board automatically. You'll have to manually add the project "Web SDK Frontend" to issues you create yourself as a contributor. |
There was a problem hiding this comment.
is this just about spacing? This is auto-formatted into these lines by prettier! (it should be rendered "normally" though)
| 1. You can look at the `#feed-web-sdk` channel in Slack. This channel will automatically receive a message every day in | ||
| the morning with issues that require triaging. |
There was a problem hiding this comment.
Should we mention slack here? Feels a bit weird considering this is a public space, but might just be me.
There was a problem hiding this comment.
🤷 I was thinking about this too. IMHO it's not too bad to have this here, the alternative is to leave this out and have this one info somewhere in notion, but then this becomes dispersed again, which means nobody will find it etc 🤔
| 1. You can look at the `#feed-web-sdk` channel in Slack. This channel will automatically receive a message every day in | ||
| the morning with issues that require triaging. | ||
| 2. You can look at the triage view in the Github Project Board: https://github.com/orgs/getsentry/projects/31/views/29 | ||
| 3. (Also for external contributors) You can filter by `Waiting for: Product Owner` label: |
There was a problem hiding this comment.
I think I would exclusively do point 3 here.
There was a problem hiding this comment.
This should be especially for the team, and also for external contributors. I want this to be the thing that folks joining the team read to know what to do, which is usually not 3 here. Triaging is not that relevant for most external contributors (it may be sometimes, but way more important for us)
| user replies again, the label will be re-added (indicating that a response from the repo owners is expected). | ||
|
|
||
| Note that issues created by contributors themselves will not get this label applied. They will also not be added to the | ||
| "Web SDK Frontend" board automatically. You'll have to add the "Web SDK Frontend" project manually to issues you create |
There was a problem hiding this comment.
I would leave out the board/project here since it's private.
docs/triaging.md
Outdated
| You can and should also move issues through the project board. You can set the status to "Backlog" (may be done at some | ||
| point), "Todo" (should be done), "In Progress" (I am working on this), "In Review" (PR is open), or "Done". This helps | ||
| have an overview what is actively being worked on at any given time. |
There was a problem hiding this comment.
Again not sure mentioning the board here is nice, since its private.
Co-authored-by: Abhijeet Prasad <[email protected]>
This adds docs about how to triage effectively. It is rather specific to this repository/team, but parts of it may also be relevant for outside contributors.
See https://github.com/getsentry/sentry-javascript/blob/fn/docs-triaging/docs/triaging.md