-
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
A maintainer or mentor actively monitors this issue and will help guide it to completion.
Important
This issue does not require prior domain knowledge.
- No Hiero or Hedera experience needed
- No distributed ledger background required
- Basic Python and Git are sufficient
β±οΈ Typical time to complete: 30β90 minutes (once setup is done)
π§© Difficulty: Small, well-contained change
π Best for: New contributors
πΎ 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
π§ 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!
π€ 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.
- 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
π€ 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.
π€ 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