Skip to content

feat: Update mentor assignment welcome message (Fixes #1487)#1488

Merged
exploreriii merged 2 commits intohiero-ledger:mainfrom
MohamedSharfan:fix/issue-1487-update-welcome-message
Jan 24, 2026
Merged

feat: Update mentor assignment welcome message (Fixes #1487)#1488
exploreriii merged 2 commits intohiero-ledger:mainfrom
MohamedSharfan:fix/issue-1487-update-welcome-message

Conversation

@MohamedSharfan
Copy link
Contributor

Description:
Update the mentor assignment welcome message to be more structured and action-oriented for new contributors.

  • Update buildComment function in .github/scripts/bot-mentor-assignment.js to use a step-by-step format (Read, Plan, Get Help).
  • Add explicit role definitions differentiating the Support Team (workflow/CI issues) from the Mentor (Python code guidance).
  • Add a direct link to the Discord setup guide (docs/discord.md) for immediate community support.
  • Improve readability with emojis and horizontal rules.

Related issue(s):

Fixes #1487

Notes for reviewer:
Ready for review @Adityarya11!
The change modifies the string returned by the buildComment function. The logic of the bot remains the same; only the content of the comment is updated to match the requirements in issue #1487.

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

Copilot AI review requested due to automatic review settings January 16, 2026 10:04
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!
Copy link

Copilot AI Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
return `👋 Hi @${mentee}, welcome to the Hiero Python SDK community!
return `${COMMENT_MARKER}
👋 Hi @${mentee}, welcome to the Hiero Python SDK community!

Copilot uses AI. Check for mistakes.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 16, 2026

Note

Other AI code review bot(s) detected

CodeRabbit 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.

Walkthrough

Updated the bot mentor assignment comment in .github/scripts/bot-mentor-assignment.js to use a conditional repository URL fallback and replace the short onboarding message with an expanded, structured three-step onboarding that calls out the Good First Issue Support Team, mentor roles, and links to Discord. CHANGELOG.md updated accordingly.

Changes

Cohort / File(s) Summary
Bot Mentor Assignment
.github/scripts/bot-mentor-assignment.js
Reworked buildComment: conditional repo URL fallback; expanded onboarding message into three steps (Read the task, Tell us your plan, Get the right kind of help); clarified roles for Good First Issue Support Team and mentor; added Discord link; adjusted formatting/placement of Mentor/Mentee lines.
Changelog
CHANGELOG.md
Updated changelog entry to note the mentor assignment bot welcome message restructuring.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'feat: Update mentor assignment welcome message (Fixes #1487)' accurately summarizes the main change: updating the mentor assignment bot's welcome message.
Description check ✅ Passed The description clearly explains the changes to the buildComment function, lists specific improvements (step-by-step format, role definitions, Discord link), and references the related issue.
Linked Issues check ✅ Passed The PR implementation addresses all key objectives from issue #1487: reformatted the message into a three-step action-oriented flow, clarified role definitions between Support Team and Mentor, added Discord link guidance, and maintained supportive tone.
Out of Scope Changes check ✅ Passed Changes are limited to updating the buildComment function in bot-mentor-assignment.js and the CHANGELOG.md entry, both directly related to issue #1487 requirements with no extraneous modifications.

✏️ 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between db523f9 and 61b0973.

📒 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.payload fields MUST be validated

  • Free-form text MUST NOT be trusted

  • Dynamic code execution is prohibited

  • Avoid child_process.exec; prefer execFile if needed

  • All 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.

Copy link
Contributor

@exploreriii exploreriii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@exploreriii
Copy link
Contributor

Hi @MohamedSharfan let's test it out, could you comment the assign word here please: exploreriii#177

Copy link
Contributor

@exploreriii exploreriii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also please add a changelog entry as required in the issue description 👍

Copy link
Contributor

@aceppaluni aceppaluni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

@MohamedSharfan MohamedSharfan force-pushed the fix/issue-1487-update-welcome-message branch from b52da3e to 74f89d8 Compare January 17, 2026 03:09
@github-actions
Copy link

[commit-verification-bot]
Hi, this is VerificationBot.
Your pull request cannot be merged as it has unverified commits.
View your commit verification status: Commits Tab.

To achieve verified status, please read:

Remember, you require a GPG key and each commit must be signed with:
git commit -S -s -m "Your message here"

Thank you for contributing!

From the Hiero Python SDK Team

…hiero-ledger#1487)

Signed-off-by: Mohamed Sharfan <sharfansaleem72@gmail.com>
@MohamedSharfan MohamedSharfan force-pushed the fix/issue-1487-update-welcome-message branch from 74f89d8 to 1b57c79 Compare January 17, 2026 04:11
@exploreriii
Copy link
Contributor

Hi please try to get assigned here please
You are a new starter so it should work
exploreriii#177

@exploreriii exploreriii marked this pull request as draft January 17, 2026 17:30
@exploreriii
Copy link
Contributor

Please test this by commenting here, exploreriii#178,
Else merge it to your fork's main and check if the new message is arriving please :)

@exploreriii
Copy link
Contributor

exploreriii commented Jan 18, 2026

@MohamedSharfan please test the comment renders correctly before working on a new issue 👍
You can do the above or read docs/sdk_developers/training/testing_forks.md thank you

@aceppaluni
Copy link
Contributor

@MohamedSharfan

If you have any questions or need assistance please let us know. We are happy to help!!

@github-actions
Copy link

Hi, this is MergeConflictBot.
Your pull request cannot be merged because it contains merge conflicts.

Please resolve these conflicts locally and push the changes.

To assist you, please read:

Thank you for contributing!

@exploreriii
Copy link
Contributor

exploreriii commented Jan 22, 2026

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
Thank you

@aceppaluni
Copy link
Contributor

@MohamedSharfan

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>
@exploreriii exploreriii marked this pull request as ready for review January 24, 2026 01:50
@codecov
Copy link

codecov bot commented Jan 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@exploreriii exploreriii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @MohamedSharfan
Let's try this !
Thank you very much for all your help and patience

@exploreriii exploreriii merged commit e9cacd1 into hiero-ledger:main Jan 24, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Good First Issue]: Edit .github/scripts/bot-mentor-assignment.js to link to discord for help

4 participants