hashgraph
[Good First Issue] : Improve clarity of token transfer example
🆕🐥 First Timers Only
This issue is reserved for people who have never contributed or have made minimal contributions to Hiero. We know that creating a pull request (PR) is a major barrier for new contributors. The goal of this issue and all other issues in find a good first issue is to help you make your first contribution to the Hiero.
👾 Description of the issue
In Token Transfer example there are no comments explaining the process of transferring a token. This is a problem as it is difficult to interpret what is going on in this action.
💡 Proposed Solution
Add a file level comment explanation to describe the process of transferring a token.
👩💻 Implementation Steps
/**
* FULL TOKEN TRANSFER
*
* This script demonstrates the complete lifecycle of a Hedera account creation using the Hiero SDK:
* Step 1: Create and configure the SDK Client.
* Step 2: Generate ED25519 key pairs.
* Step 3: Create two new accounts.
* Step 4: Create a Fungible Token
* Step 5: Associate the token with created accounts.
* Step 6: Grant token KYC for created accounts.
* Step 7: Transfer tokens from the operator (treasury) to Alice's account.
* Step 8: Transfer 10 tokens from the Alice to Bob and vis-versa
...
*/
✅ Acceptance Criteria
To be able to merge a pull request for this issue, we need:
- [ ] Changelog Entry: Correct changelog entry
- [ ] Signed commits: commits must be DCO and GPG key signed
- [ ] All Tests Pass: our workflow checks like unit and integration tests must pass
- [ ] Issue is Solved: The implementation fully addresses the issue requirements as described above
- [ ] No Further Changes are Made: Code review feedback has been addressed and no further changes are requested
📋 Step-by-Step Contribution Guide
If you have never contributed to an open source project at GitHub, the following step-by-step guide will introduce you to the workflow. More information and concrete samples for shell commands for each step can be found in our CONTRIBUTING.md file. A more detailed general documentation of the GitHub PR workflow can be found here.
- [ ] Claim this issue: Comment below that you are interested in working on the issue
- [ ] Wait for assignment: A community member with the given rights will add you as an assignee of the issue
- [ ] Work on the issue: Follow the detailed description in our CONTRIBUTING.md file.
- [ ] You did it 🎉: We will merge the fix in the main branch. Thanks for being part of the Hiero community as an open-source contributor!
IMPORTANT Your pull request CANNOT BE MERGED until your commits are each with git commit -S -s -m "chore: your commit message" with a GPG key setup.
🤔 Additional Information
If you have any questions about the topic of this issue, please ask us directly by adding a comment below. Additionally, we invite you to join our community on our Discord server or attend our public community calls.
A general manual about open-source contributions can be found here.
