feat: Update mentor assignment welcome message (Fixes #1487)#1488
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the mentor assignment welcome message in the bot script to be more structured and action-oriented, addressing issue #1487. The message now includes explicit step-by-step guidance, role definitions, and a link to Discord for community support.
Changes:
- Restructured the welcome message into three clear steps: Read the task, Tell us your plan, and Get the right kind of help
- Added explicit role definitions differentiating the Support Team (workflow/CI issues) from the Mentor (Python code guidance)
- Included a direct link to the Discord setup guide for immediate community support
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| const MENTOR_TEAM_ALIAS = "@hiero-ledger/hiero-sdk-python-triage"; | ||
| const SUPPORT_TEAM_ALIAS = "@hiero-ledger/hiero-sdk-good-first-issue-support"; | ||
|
|
||
| return `👋 Hi @${mentee}, welcome to the Hiero Python SDK community! |
There was a problem hiding this comment.
The COMMENT_MARKER is no longer included in the returned comment string. This marker is used on lines 193 and 231 to detect whether a mentor assignment comment has already been posted on an issue. Without this marker, the bot will not be able to identify existing comments, potentially causing duplicate mentor assignment comments to be posted on the same issue.
| return `👋 Hi @${mentee}, welcome to the Hiero Python SDK community! | |
| return `${COMMENT_MARKER} | |
| 👋 Hi @${mentee}, welcome to the Hiero Python SDK community! |
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughUpdated the bot mentor assignment comment in Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
.github/scripts/bot-mentor-assignment.js
🧰 Additional context used
📓 Path-based instructions (1)
.github/scripts/**/*.js
⚙️ CodeRabbit configuration file
.github/scripts/**/*.js: Review JavaScript scripts as long-lived automation code.Scripts must remain:
Focused
Readable
Purpose-built
All
context.payloadfields MUST be validatedFree-form text MUST NOT be trusted
Dynamic code execution is prohibited
Avoid
child_process.exec; preferexecFileif neededAll async operations MUST be wrapped in try/catch
Errors MUST include contextual metadata
Duplicate API calls MUST be avoided
Marker-based deduplication is required
Scripts MUST NOT assume write access
Permission failures MUST be handled gracefully
Files:
.github/scripts/bot-mentor-assignment.js
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Agent
- GitHub Check: Codacy Static Code Analysis
- GitHub Check: StepSecurity Harden-Runner
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
exploreriii
left a comment
There was a problem hiding this comment.
Hi @MohamedSharfan
Thank you for this PR, it is coming along really well.
You have changed the function buildComment parameters, not just the comment inside it.
This is causing some trouble.
Can you revert your change, and make sure you don't change what was originally line 107 to 110?
As the AI reviewers note, you can look inside bot-mentor-assignment.js near the top and you'll see some of the variables you are creating already exist. Creating new versions can cause problems. Their feedback is really helpful.
In short, you should aim to keep the FUNCTIONALITY the same, but change the comment MESSAGE. Currently, this PR will break the bot.
Recommendation:
git reset --soft HEAD~1 then
keep as much of the original functionality as possible, only aim to change the comment message.
Thank you
|
Hi @MohamedSharfan let's test it out, could you comment the assign word here please: exploreriii#177 |
exploreriii
left a comment
There was a problem hiding this comment.
Also please add a changelog entry as required in the issue description 👍
aceppaluni
left a comment
There was a problem hiding this comment.
@MohamedSharfan This is fantastic work!!
I've linked our CHANGELOG-ENTRY.md file for reference.
Please let us know if you have any questions. We are always happy to help.
b52da3e to
74f89d8
Compare
|
[commit-verification-bot] To achieve verified status, please read: Remember, you require a GPG key and each commit must be signed with: Thank you for contributing! From the Hiero Python SDK Team |
…hiero-ledger#1487) Signed-off-by: Mohamed Sharfan <sharfansaleem72@gmail.com>
74f89d8 to
1b57c79
Compare
|
Hi please try to get assigned here please |
|
Please test this by commenting here, exploreriii#178, |
|
@MohamedSharfan please test the comment renders correctly before working on a new issue 👍 |
|
If you have any questions or need assistance please let us know. We are happy to help!! |
|
Hi, this is MergeConflictBot. Please resolve these conflicts locally and push the changes. To assist you, please read: Thank you for contributing! |
|
Hi @MohamedSharfan I am unable to proceed with this as it is untested, please comment /assign here exploreriii#178 or if that is not working, please follow docs/sdk_developers/training/testing_forks.md |
|
If you have any questions on testing please reach out. We are happy to assist! |
Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #1488 +/- ##
=======================================
Coverage 92.89% 92.89%
=======================================
Files 140 140
Lines 8765 8765
=======================================
Hits 8142 8142
Misses 623 623 🚀 New features to boost your workflow:
|
exploreriii
left a comment
There was a problem hiding this comment.
Hi @MohamedSharfan
Let's try this !
Thank you very much for all your help and patience
Description:
Update the mentor assignment welcome message to be more structured and action-oriented for new contributors.
buildCommentfunction in.github/scripts/bot-mentor-assignment.jsto use a step-by-step format (Read, Plan, Get Help).docs/discord.md) for immediate community support.Related issue(s):
Fixes #1487
Notes for reviewer:
Ready for review @Adityarya11!
The change modifies the string returned by the
buildCommentfunction. The logic of the bot remains the same; only the content of the comment is updated to match the requirements in issue #1487.Checklist