Skip to content

[Good First Issue]: Remove stray * character in AccountAllowanceSerializedExample.cpp doc comment #1213

@rwalworth

Description

@rwalworth

🆕🐥 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.

Important

📋 About Good First Issues

Good First Issues are designed to make getting started as smooth and stress-free
as possible.

They usually focus on:

  • Small, clearly scoped changes
  • Straightforward updates to existing code or docs
  • Simple refactors or clarity improvements

Other kinds of contributions — like larger features, deeper technical changes,
or design-focused work — are just as valuable and often use the beginner, intermediate, or advanced labels.


👾 Description of the Issue

The file:

src/sdk/examples/AccountAllowanceSerializedExample.cpp

has a stray * character at the end of a line in the top-level documentation comment. On line 24, the text reads:

 * - Clean up the ledger by resetting the allowance and deleting all generated accounts. *

The trailing * at the end of the line is unintentional. For comparison, all other bullet points in the same comment block end with a period and no trailing *:

 * - Query account balances to verify the flow of funds.

💡 Proposed Solution

Remove the stray * from the end of line 24 so it ends cleanly with a period, matching the other bullet points in the comment.

The changes should:

  • Not modify any existing logic
  • Not change behavior or public APIs
  • Be limited to removing the stray character only
  • Bring the formatting in line with the other bullet points in the same comment

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

To complete this change:

  • Open src/sdk/examples/AccountAllowanceSerializedExample.cpp

  • On line 24, remove the trailing *:

    Before:

     * - Clean up the ledger by resetting the allowance and deleting all generated accounts. *

    After:

     * - Clean up the ledger by resetting the allowance and deleting all generated accounts.
  • Run existing tests or CI locally if already set up
    (CI will also run automatically when you open a pull request)

This change should only affect a comment. No logic or behavior changes.

Files to change (1 total):

File Line Change
src/sdk/examples/AccountAllowanceSerializedExample.cpp 24 Remove stray trailing *

✅ Acceptance Criteria

To merge a pull request for this issue:

  • Scope: Changes are limited to removing the stray * on line 24
  • 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!

Metadata

Metadata

Assignees

Labels

kind: documentationImprovements or additions to READMEs, guides, API docs, or code commentspriority: lowNon-urgent tasks, nice-to-have improvements, or minor issuesscope: examplesRelated to example projects or snippetsskill: good first issueSimple, well-scoped tasks ideal for someone new to the repository or open source

Type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions