[Good First Issue]: Update JSDoc to reflect updated validation logic

[Egbaiyelo]

🆕🐥 First-Time Friendly

This issue is especially welcoming for people who are new to contributing to the Hiero C++ SDK.

We know that opening your first pull request can feel like a big step.
Issues labeled Good First Issue are designed to make that experience easier, clearer, and more comfortable.

No prior knowledge of Hiero, Hedera, or distributed ledger technology is required.
Just a basic familiarity with C++ and Git is more than enough to get started.

---

👾 Description of the Issue

The file:
.github/scripts/helpers/validation.js

The logic for auto-assignment of PRs was recently updated to allow GitHub bot accounts - suffixed with [bot], but the documentation has lagged behind the changes.

Make changes to the JSDoc to reflect the update.

---

💡 Proposed Solution

Update the comments in
.github/scripts/helpers/validation.js in the isSafeSearchToken() method to look more like this

/**
 * Returns true if value is a string safe for GitHub search queries (type and format).
 * Allows standard alphanumeric characters, `.`, `_`, `/`, `-`, and the optional
 * GitHub bot suffix `[bot]` (e.g. `dependabot[bot]`).
 * Two checks: is string and matches safe character set. 
 * @param {*} value
 * @returns {boolean}
 */

The changes should:

Not modify any existing logic
Not change behavior or public APIs
Be limited to comments only
Improve readability for new contributors

---

👩‍💻 Implementation Steps (End-to-End)

To complete this change:

• Open .github/scripts/helpers/validation.js
• Locate the following methods that need comments:
  • isSafeSearchToken()
• Add concise, single-line comments above the method that explains:
• What the method does
• When it is used in the bot assignment workflow.

---

✅ Acceptance Criteria

To merge a pull request for this issue:

• Scope: Changes are limited to this issue
• Behavior: No SDK behavior or public API changes
• Tests: Existing CI checks pass
• Review: All code review feedback addressed

---

📋 Step-by-Step Contribution Guide

To help your first contribution go as smoothly as possible, we recommend following these steps:

• Comment /assign to request the issue
• Wait for assignment
• Fork the repository and create a branch
• Set up the project by following the instructions in README.md
• Make the requested changes
• Sign each commit using -s -S
• Push your branch and open a pull request

Read Workflow Guide for step-by-step workflow guidance.
Read README.md for setup instructions.

❗ Pull requests cannot be merged without S and s signed commits.
See the Signing Guide.

---

🤔 Additional Information

If you need help, reach out to the @hiero-ledger/hiero-sdk-good-first-issue-support team.

You can also join our community on Discord:
Hiero-SDK-C++

Maintainers are happy to help first-time contributors succeed!

[rwalworth]

Thanks for putting this together @Egbaiyelo! The issue is valid and the structure is clear - a few quick things to fix before we label it and open it up:

1. Broken JSDoc close tag - the Proposed Solution has * / (with a space) instead of */. Any contributor copy-pasting that will end up with invalid syntax. Please fix to */.

2. "Transaction flow" in implementation steps - the implementation steps say "when it is used in the transaction flow." This file is a CI/bot script, not SDK transaction code. Please update that line to something like "when it is used in the bot assignment workflow."

Once those are in, this looks like a clean, well-scoped GFI!

[Ridhi-03Kumari]

Hi , I would like to work on this issue.

I understand that the current JSDoc for "isSafeSearchToken()" is outdated and does not reflect the updated validation logic (especially support for GitHub bot usernames like "[bot]").

I will update the JSDoc comments to:

• Accurately describe the validation logic
• Include allowed characters and "[bot]" suffix handling
• Fix formatting issues (like incorrect closing tag)
• Ensure wording reflects the CI/bot assignment workflow instead of transaction flow

Please assign this issue to me. Thank you!

[rwalworth]

Hi @Ridhi-03Kumari, when this issue is fully triaged and finalized, it will be labelled status: ready for dev. Once that happens, comment "/assign" and the bot will assign you the issue!

[Ridhi-03Kumari]

Thank you for the info @rwalworth! I'll wait for the "status: ready for dev" label and then comment "/assign". Looking forward to work on this!

[Egbaiyelo]

@rwalworth Changes made.