oppiabot icon indicating copy to clipboard operation
oppiabot copied to clipboard

Improve message for asking contributors to assign the required reviewer(s) for a PR.

Open seanlip opened this issue 1 year ago • 11 comments

Is your feature request related to a problem? Please describe.

When a new PR is opened, Oppiabot leaves a message saying

"Hi @XXX please assign the required reviewer(s) for this PR. Thanks!"

However, for new contributors who don't have "assign" rights, this results in them not being sure what to do.

Describe the solution you'd like

I'd suggest changing the message to:

"Hi @XXX, please assign the required reviewer(s) for this PR. This is necessary for your PR to get reviewed and merged.

Note: If you don't have permissions to modify the "Assignees" section, just leave a comment here saying @{{reviewer_username}} PTAL and I'll help you assign them. Thanks!"

seanlip avatar Mar 22 '24 11:03 seanlip

Hey @seanlip is this issue solved by @vojtechjelinek ? If yes then please close the issue and if not then please assign it to me.

Flying-Pegasus avatar Dec 09 '24 05:12 Flying-Pegasus

@Flying-Pegasus I don't think it's been solved. I deassigned @vojtechjelinek.

However, per the guidance at https://github.com/oppia/oppia/wiki/Contributing-code-to-Oppia#choosing-a-good-first-issue, please provide an explanation of what your PR will do (with names of files you're changing, what you plan to change in each file, etc.), as well as a video showing that the changes work correctly on your local machine. If it looks good, we can assign you to this issue. Thanks!

seanlip avatar Dec 09 '24 06:12 seanlip

Proposed: Improve message for asking contributors to assign the required reviewer(s) for a PR.

Files to be Updated

  • checkPullRequestLabels.js .

Proposed Changes

Existing line of code:

const message =
   'Hi @' +
   author +
   ' please assign the required reviewer(s) for this PR. Thanks!';

Updated statement in the code:

const message =
   'Hi @' +
   author +
   ' please assign the required reviewer(s) for this PR.' +
   ' This is necessary for your PR to get reviewed and merged.' +
   'Note: If you do not have permissions to modify the Assignees section, just leave a comment here saying @{{reviewer_username}} PTAL and I will help you assign them. Thanks!' ;

Why These Changes Are Necessary

  • For new contributors who don't have "assign" rights, this will help them what to do.

Next Steps

Hey, @seanlip if this issue is assigned to me, I will:

1.Implement the above changes in the checkPullRequestLabels.js. 2.Submit a pull request for review.

Flying-Pegasus avatar Dec 09 '24 12:12 Flying-Pegasus

@Flying-Pegasus I think you need to do a bit more here. Please read the full issue description carefully including the last paragraph.

seanlip avatar Dec 09 '24 15:12 seanlip

Okay you mean I have to add

Note: If you don't have permissions to modify the "Assignees" section, just leave a comment here saying @{{reviewer_username}} PTAL and I'll help you assign them. Thanks!"

This statement as well? @seanlip

Flying-Pegasus avatar Dec 09 '24 15:12 Flying-Pegasus

Yes.

seanlip avatar Dec 09 '24 15:12 seanlip

@seanlip I have updated the comment please review it. Thank you.

Flying-Pegasus avatar Dec 09 '24 17:12 Flying-Pegasus

@Flying-Pegasus Could you please test this and demonstrate that your changes are correct (show a screenshot the message that Oppiabot leaves)? This will help you find the improvements that need to be made to your code.

seanlip avatar Dec 10 '24 06:12 seanlip

Okay

Flying-Pegasus avatar Dec 10 '24 11:12 Flying-Pegasus

Hi @seanlip

I wanted to check if the issue #335 regarding Oppiabot's message for new contributors has been resolved. If not, could you please assign it to me? I’d like to work on implementing the suggested solution.

ajeetkumarrauniyar avatar Jan 12 '25 05:01 ajeetkumarrauniyar

Sorry, we're not taking contributions for Oppiabot. I've removed the good first issue label from this issue. Please see https://github.com/oppia/oppia/wiki/Contributing-code-to-Oppia for general contribution instructions -- thanks!

seanlip avatar Jan 13 '25 06:01 seanlip