-
Notifications
You must be signed in to change notification settings - Fork 3
Description
🆕🐥 Newcomer Friendly
This Good First Issue is a guided, well-scoped task intended for new contributors to the Hiero Python SDK.
It is designed to help you:
- understand how the repository is structured
- practice the standard contribution workflow
- submit and merge a pull request
No prior knowledge of Hiero, Hedera, or distributed ledger technology is required.
Familiarity with basic Python and Git is sufficient.
A maintainer or mentor actively monitors this issue and will help guide it to completion.
⏱️ Typical time to complete: 30–90 minutes (once setup is done)
🧩 Difficulty: Small, well-contained change
🎓 Best for: New contributors
🧭 Getting help if you’re stuck
If you run into questions or get blocked, don’t spend more than 20 minutes stuck on your own.
You can:
- comment on this issue and tag
@good_first_issue_support_teamor@mentor_name - ask for help in Discord
Getting stuck and reaching out for help is a normal part of the contribution process.
Even partial progress or draft pull requests are welcome!
👾 Issue description
This issue addresses a small but real improvement needed at the Hiero Python SDK.
Edit here. Example provided below.
💡 Proposed Solution
Edit here. Example provided below.
🛠️ Implementation Steps
Edit here. Example provided below.
📋 Step-by-Step Setup Guide
Suggestions:
-
Visual Studio (VS) Code: Guide
-
GitHub Desktop: Guide
-
Hedera Testnet Account with root .env file: Guide
-
Create a GPG key linked to GitHub: Guide
Setup the Hiero Python SDK for development
-
Fork Create an online and local copy of the repository: Guide
-
Connect origin with upstream: Guide
-
Install Packages and protobuffs: Guide
-
Sync Main pull any recent upstream changes: Guide
You are set up! 🎉
📋 Step-by-step contribution guide
✅ Get ready
-
Claim the issue: comment
/assign: Guide -
Double check the Issue and AI plan: carefully re-read the issue description and the CodeRabbit AI plan
-
Ask questions early: ask on Discord, your
@mentor(Python SDK help) and the@good_first_issue_support_team(setup and workflow help) -
Sync with main: pull the latest upstream changes Guide
-
💡 Tip: Before coding, leave a short comment describing what you plan to change. We’ll confirm you’re on the right track.
🛠️ Solve the Issue
-
Create a branch from
main: Guide -
Implement the solution: follow the implementation steps in the issue description.
-
Commit with DCO and GPG signing: commit changes using:
git commit -S -s -m "chore: your message", Guide -
Add a
.CHANGELOG.mdentry: under the appropriate [UNRELEASED] section and commit asgit commit -S -s -m "chore: changelog entry"Guide
🚀 Create the pull request
-
Push your commits: push your branch to your fork
git push origin your-branch-name -
Complete the PR description: briefly describe your changes, Guide
-
Link the Issue: link the issue the PR solves in the PR description, Guide
-
Submit the pull request: click
**Create pull request**🎉
✅ Acceptance criteria
To be able to close this issue, the following criteria must be met:
-
The issue is solved: I’ve carefully read and implemented the issue requirements
-
I did not add extra changes: I did not modify anything beyond what is described in the issue
-
Behavior: All other existing features continue to work as before
-
Checks and feedback: All checks pass and any requested changes have been made
🤔 What to expect after submitting a PR
Once you open a pull request, here’s what happens next:
🤖 Automated checks
A few automated checks will run and all must pass before your PR can be merged, such as:
- signing
- changelog entry
- solo unit and integration tests
- examples
- code quality checks
👉 You can open each check to see detailed results and error messages if anything fails.
🤝 AI feedback (CodeRabbit)
You’ll receive quick feedback from CodeRabbit AI, which may:
- point out potential issues
- suggest improvements or alternatives
AI feedback is advisory — it can make mistakes - use what’s helpful and relevant to the issue description.
😎 Team Member review
A Python SDK team member will review your PR, typically within 1–3 days.
Reviews focus on clarity and learning, and do not expect perfection.
- You may be asked to make changes, or
- Your PR may be approved as-is ✅
Once approved, PRs are usually merged within one day.
🔄 Merge conflicts
Merge conflicts can occasionally happen as the SDK updates. This is normal and fixable.
-
Changelog conflicts
These are common and can usually be resolved by accepting both changes using GitHub’s online editor in the pull request. -
Other conflicts
More complex conflicts may require rebasing your branch and resolving them locally.
👉 Follow the step-by-step Rebasing Guide for help.
🏁 What success looks like
When this issue is complete, you will have:
✅ Solved a real issue we need resolving
✅ a merged pull request in the Hiero Python SDK
✅ your name permanently in the project history
✅ confidence to take on larger issues next
🤔 Additional Help
First Points of Contact:
- Discord
- Comment with
@mentor_name(for Python SDK questions) - Comment with
@hiero-ledger/hiero-sdk-good-first-issue-support(for setup and workflow questions)
The more you ask, the more you learn and so do we!
Documentation:
Calls:
- Get hands-on-help by our expert team at our Office Hours
- Learn, raise issues and provide feedback at Community Calls
🤖 AI usage guidelines
You’re welcome to use AI tools while working on this issue.
Many contributors do — especially for:
- understanding unfamiliar code
- drafting small refactors
- sanity-checking approaches
Use AI responsibly:
- review suggestions carefully
- apply changes incrementally
- test as you go
If in doubt, ask — maintainers are happy to help.