Skip to content

[Good First Issue]: TEST STEPS BUT NOT FLOW #181

@exploreriii

Description

@exploreriii

🆕🐥 Newcomer Friendly

Welcome 👋!
This Good First Issue is especially friendly to newcomers to the Hiero Python SDK.

No prior knowledge of Hiero, Hedera, or distributed ledger technology is required and 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
    - [ ] GitHub Desktop Guide
    - [ ] Hedera Testnet Account with root .env file Guide
    - [ ] Create a GPG key and tie it 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
    - [ ] Connect origin with upstream Guide
    - [ ] Install Packages Install packages and protobuffs Guide
    - [ ] Sync Main pull any recent upstream changes Guide
    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 on the issue to get assigned.
    Assignment guide

  • Read the issue carefully:
    Review the issue description and the CodeRabbit AI plan.

  • Ask questions early:
    Reach out on Discord or to your mentor for implementation questions, or comment with @good_first_issue_support_team for setup or workflow help.

  • Sync with main:
    Pull the latest upstream changes.
    Rebasing guide

🛠️ Start solving the issue

  • Create a branch from main:
    Create a working branch for your changes.
    Branching guide

  • Work on the solution:
    Implement the changes described in the issue.

  • Commit with DCO and GPG signing:
    Commit your changes using:
    git commit -S -s -m "chore: your message"
    Signing guide

  • Add a changelog entry:
    Add an entry to .CHANGELOG.md under the appropriate [UNRELEASED] section and commit it separately.
    Changelog guide

🚀 Create the pull request

  • Push your commits:
    Push your branch to your fork (e.g. git push origin your-branch-name).

  • Open a pull request:
    Create a pull request here.
    Pull request guide

  • Complete the PR description:
    Briefly describe your changes and link the issue being resolved Linking 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 (signing, changelog, tests, examples, and code quality).

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 next, 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 your @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!

###Helpful Documentation:

###Helpful 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 automated checks pass and any requested feedback has been addressed.

🤖 AI usage guidelines

You’re welcome to use AI tools 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions