-
Notifications
You must be signed in to change notification settings - Fork 3
Description
🆕🐥 Newcomer Friendly
Welcome 👋!
This Good First Issue is friendly to newcomers to the Hiero Python SDK.
No prior knowledge of Hiero, Hedera, or distributed ledger technology is required.
Basic familiarity with Python and Git is enough.
👾 Issue description
Edit here. Example provided below.
💡 Proposed Solution
Edit here. Example provided below.
🛠️ Implementation Steps
Edit here. Example provided below.
📋 Step-by-Step Setup Guide
Please follow these steps to setup:
Suggested Pre-requisites
- [ ] Visual Studio (VS) Code [Guide](docs/sdk_developers/training/workflow/01_supporting_infrastructure.md)
- [ ] GitHub Desktop [Guide](docs/sdk_developers/training/workflow/01_supporting_infrastructure.md)
- [ ] Hedera Testnet Account with root .env file [Guide](docs/sdk_developers/training/setup/03_setting_up_env.md)
- [ ] Create a GPG key linked to GitHub [Guide](docs/sdk_developers/signing.md)
Setup the Hiero Python SDK for development
- [ ] **Fork** Create an online and local copy of the repository [Guide](docs/sdk_developers/training/workflow/02_forking_python_sdk.md)
- [ ] **Connect** origin with upstream [Guide](docs/sdk_developers/training/workflow/03_staying_in_sync.md)
- [ ] **Install Packages** Install packages and protobuffs [Guide](docs/sdk_developers/training/setup/02_installing_hiero_python_sdk.md)
- [ ] **Sync Main** pull any recent upstream changes [Guide](docs/sdk_developers/rebasing.md)
That's it! 🎉 We are ready to get started.
📋 Step-by-step contribution guide
Please follow these steps to contribute:
✅ Get ready
-
Claim the issue: Comment
/assignGuide -
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) or the
@good_first_issue_support_team(setup help) -
Sync with main:. Pull the latest upstream changes Guide
🛠️ Solve the Issue
-
Create a branch from
main: Guide -
Implement the solution
-
Commit with DCO and GPG signing: Commit your changes using:
git commit -S -s -m "chore: your message"Guide -
Add a
.CHANGELOG.mdentry: under the appropriate [UNRELEASED] section andgit 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 and link the issue Guide.
-
Submit the pull request: Click Create pull request 🎉
🤔 What to expect after submitting a PR
Once you open a pull request, a few automated checks will run that will all need to pass (signing, changelog, tests, examples, and code quality). Open each test result to see details.
You’ll also get quick feedback from CodeRabbit AI, which may point out issues or suggest improvements. AI feedback is advisory—use what’s helpful.
A Python SDK team member will review your PR, usually within 1–3 days. You may be asked to make changes or your PR may be approved.
After approval, PRs are typically merged within a day.
🔄 Merge conflicts
Merge conflicts can happen as the SDK updates:
- Changelog conflicts: use the online editor in the PR
- Other conflicts may require rebasing and manual resolution Guide
🤔 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
✅ Acceptance criteria
-
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.
🤖 AI usage guidelines
You’re welcome to use AI tools responsibly while working on this issue.
Please review suggestions carefully, build step by step, and test changes as you go.
If anything’s unclear, a mentor or maintainer is happy to help.