Skip to content

Commit 1b57c79

Browse files
feat: Update mentor assignment welcome message and CHANGELOG.md (Fixes #1487)
Signed-off-by: Mohamed Sharfan <sharfansaleem72@gmail.com>
1 parent db523f9 commit 1b57c79

File tree

2 files changed

+49
-17
lines changed

2 files changed

+49
-17
lines changed

.github/scripts/bot-mentor-assignment.js

Lines changed: 48 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -105,25 +105,57 @@ async function isNewContributor(github, owner, repo, login) {
105105
}
106106

107107
function buildComment({ mentee, mentor, owner, repo }) {
108-
const repoUrl = `https://github.com/${owner}/${repo}`;
109-
110-
return `${COMMENT_MARKER}
111-
👋 Hi @${mentee}, welcome to the Hiero Python SDK community!
112-
113-
You've been assigned this Good First Issue, and today’s on-call mentor from ${MENTOR_TEAM_ALIAS} is @${mentor}. They're here to help you land a great first contribution.
114-
115-
**How to get started**
116-
- Review the issue description and any linked docs
117-
- Share updates early and ask @${mentor} anything right here
118-
- Keep the feedback loop short so we can support you quickly
119-
120-
Need more backup? ${SUPPORT_TEAM_ALIAS} is also on standby to cheer you on.
121-
108+
const repoUrl = owner && repo ? `https://github.com/${owner}/${repo}` : "https://github.com/hiero-ledger/hiero-sdk-python";
109+
110+
return `${COMMENT_MARKER}👋 Hi @${mentee}, welcome to the Hiero Python SDK community!
111+
You've been assigned this **Good First Issue**. Your on-call mentor today from ${MENTOR_TEAM_ALIAS} is **@${mentor}**, and the **Good First Issue Support Team** is **${SUPPORT_TEAM_ALIAS}**.
112+
We’re here to help you get your first PR merged successfully 🚀
113+
114+
---
115+
### Step 1: Read the task
116+
- Open the issue description, carefully read the requirements and workflow
117+
- Read any linked documentation
118+
- Make sure you understand the expected outcome
119+
If anything is unclear, ask your mentor **before** writing code.
120+
121+
---
122+
### Step 2: Tell us your plan (in this thread)
123+
Reply here with:
124+
- What you think the task is
125+
- What you plan to change to solve the issue requirement and no more
126+
- Any questions you have
127+
This means we can guide you early on, helping you to have a more stress free experience
128+
129+
---
130+
### Step 3: Get the right kind of help
131+
Finishing your first PR can be really hard. We are here to help you - please ask us!
132+
133+
🛠 **Good First Issue Support Team (${SUPPORT_TEAM_ALIAS})**
134+
Use them for **workflow and GitHub issues**, such as:
135+
- Failing CI checks
136+
- Commit signing problems
137+
- Merge conflicts
138+
- Git/GitHub errors
139+
They can also jump on a call if needed.
140+
141+
🐍 **Your Mentor (@${mentor})**
142+
Use your mentor for **Python and code guidance**, such as:
143+
- Which files to edit
144+
- How to structure your solution
145+
- Docstring and code style questions
146+
- Making sure your PR meets the issue requirements
147+
148+
💬 **Discord (for fast help)**
149+
Guide: [Join the Python SDK Discord](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/discord.md)
150+
Use Discord when you need **immediate answers** from the community, like:
151+
- What docs to read
152+
- How to unblock yourself quickly
153+
- Clarifying next steps in real time
154+
155+
---
122156
**Mentor:** @${mentor}
123157
**Mentee:** @${mentee}
124-
125158
If you're enjoying the SDK, consider ⭐️ [starring the repository](${repoUrl}) so it's easy to find later.
126-
127159
Happy building!
128160
— Python SDK Team`;
129161
}

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
103103
- Add GitHub Actions script and workflow for automatic spam list updates.
104104
- Added technical docstrings and hardening (set -euo pipefail) to the pr-check-test-files.sh script (#1336)
105105
- Added prompt for coderabbit to review `Query` and it's sub-classes.
106-
106+
- Updated the mentor assignment bot welcome message to be more structured. ([#1487](https://github.com/hiero-ledger/hiero-sdk-python/issues/1487))
107107
### Changed
108108
- Refactored the advanced issue assignment guard to use a single configurable variable for the required number of completed intermediate issues. (#1479)
109109
- Align Good First Issue and Good First Issue — Candidate guidelines with the Hiero C++ SDK for clarity and consistency.(#1421)

0 commit comments

Comments
 (0)