Skip to content

[Good First Issue]: styling test #185

@exploreriii

Description

@exploreriii

🆕🐥 Newcomer Friendly

Welcome 👋

This Good First Issue is a beginner-friendly starting point for the Hiero Python SDK.

You don’t need any background in:

  • Hiero or Hedera
  • distributed ledger technology

If you’re comfortable with basic Python and Git, you’re ready to get started.

👾 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

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 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.

🛠️ 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.md entry: under the appropriate [UNRELEASED] section and commit as git 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.

  • Open a pull request: here Guide.

  • 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, 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 feel free to ask questions.

👀 Maintainer review

A Python SDK team member will review your PR, typically within 1–3 days.

  • You may be asked to make changes, or
  • Your PR may be approved as-is ✅

🚀 Merge

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 directly 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.

🤔 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:

✅ 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.

🤖 AI usage guidelines

You’re welcome to use AI tools while working on this issue.

Use AI responsibly:

  • Verify suggestions before applying them, such as by looking at similar examples
  • Work one small change at a time
  • Create small tests/checks as you go

For Hiero Python SDK expert guidance:

  • Ask a mentor/maintainer, they are happy to guide you on our best practices

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions