-
Notifications
You must be signed in to change notification settings - Fork 25
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
add (optional) reviewer in addition to comment #499
Comments
I will just add our background story for this to have a whole picture :) This PR, quarkusio/quarkus#44597 , enhances our notification system for situations where upstream updates are made to docs that are marked for downstreaming. While email notifications are helpful, we need more than email notifications for our team to act quickly and efficiently. To address this, I propose that myself, Sheila, and Rolfe be automatically added as Reviewers or Assignees for such PRs, alongside any Subject Matter Expert (SME) responsible for the respective document. This would allow us to receive notifications directly in our IDEs, such as VS Code or IntelliJ, through their GitHub plugins. With this setup, we can see where our attention is required and provide timely reviews directly in Quarkus as soon as the PR is opened rather than during pre-release QE reviews. Our reviews would focus solely on grammar and style and would not act as blockers. The goal is to ensure that we react promptly to contributions and improve documentation quality at the earliest stage while preserving the contributor's original intent. A key advantage of integrating these notifications into IDEs is the ability to branch into the PR with a single click and, if necessary, directly commit updates after reaching an agreement with the PR author. This streamlined workflow would help us provide value-added reviews efficiently. We used a similar approach in Eclipse Che, which proved effective. |
Currently, we have two docs labels in GitHub.
|
could we add "add as reviewer" on issues in addition to comment?
usecase is that comments you need to catch "as they come on" and is done for docs on quarkusio/quarkus#44597;
However, if users are added as reviewers, they can query and find them explicitly.
that could be used for code prs in general too, but specific ask is from idea from docs (cc @MichalMaler )
to catch issues sooner.
The text was updated successfully, but these errors were encountered: