-
Notifications
You must be signed in to change notification settings - Fork 147
chore: add beginner template issue #1330
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
exploreriii
merged 5 commits into
hiero-ledger:main
from
exploreriii:beginner-template-issue
Jan 4, 2026
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
ce8a707
feat: beginner template
exploreriii c4f38a9
chore: bump intermediate and advanced templates
exploreriii ab5df5e
chore: add beginner issue template
exploreriii 6caf6ad
chore: coderabbit review fixes
exploreriii 041282e
fix: copy paste error
exploreriii File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,272 @@ | ||
| name: Beginner Issue Template | ||
| description: Create a Beginner Issue for fairly new contributors | ||
| title: "[Beginner]: " | ||
| labels: ["beginner"] | ||
| assignees: [] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| --- | ||
| ## **Thanks for contributing!** 😊 | ||
|
|
||
| We truly appreciate your time and effort. If this is your first open-source contribution, welcome! | ||
| This template is designed to help you create a Beginner-friendly issue: an easy, well-scoped task that helps new contributors learn the codebase and build their skills. | ||
| --- | ||
| - type: textarea | ||
| id: intro | ||
| attributes: | ||
| label: 🐥 Beginner Friendly | ||
| description: Who is this issue for? | ||
| value: | | ||
| This issue is intended for contributors who have previously completed a Good First Issue in [Hiero](https://hiero.org) and are at a beginner level. | ||
| We recognize that gaining confidence and building skills are equally important steps in the open-source contributor journey. | ||
| The purpose of this issue—and others listed under [**Find a beginner issue**](https://github.com/hiero-ledger/hiero-sdk-python/issues?q=is%3Aissue%20state%3Aopen%20label%3Abeginner%20no%3Aassignee)—is to provide a supportive, low-pressure environment where you can learn, practice, and grow your contribution skills with confidence. | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| > [!IMPORTANT] | ||
| > ### 🐥 Beginner Issue Guidelines | ||
| > | ||
| > Beginner Issues are intended for contributors who are familiar with the project workflow and have **some programming experience** and are wanting opportunities to build skills. | ||
| > These issues may require **light investigation, interpretation of existing code, and some self-initiative**, but should remain **well-scoped with a clear intent**. | ||
| > | ||
| > **What we generally consider beginner issues:** | ||
| > | ||
| > - **Small, well-scoped updates to existing tests**: | ||
| > - Adjusting or extending an existing test to cover a simple case | ||
| > - **Narrow changes or additions to `src` functionality** using common Python skills, such as: | ||
| > - Implementing or refining `__str__` methods | ||
| > - Implementing or refining `__repr__` methods | ||
| > - Typing improvements, such as return type hints or basic type conflicts | ||
| > - **Documentation improvements** in examples such as creating new examples or docstrings for existing functions | ||
| > - **Functional improvements to existing examples**: | ||
| > - Adding steps or variations to better demonstrate functionality | ||
| > | ||
| > **What we generally do NOT consider beginner issues:** | ||
| > - Tasks better suited for Good First Issues (purely mechanical or fully guided changes) | ||
| > - Creating entirely new examples or test suites | ||
| > - Changes to core DLT functionality (for example, `to_proto` or `from_proto`) | ||
| > - Work that requires deep knowledge across multiple areas of the codebase | ||
|
|
||
| > 📖 *For a more detailed explanation, refer to: | ||
| > [`docs/maintainers/beginner_issue_guidelines.md`](docs/maintainers/beginner_issue_guidelines.md).* | ||
exploreriii marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - type: textarea | ||
| id: issue | ||
| attributes: | ||
| label: 👾 Description of the issue | ||
| description: | | ||
| DESCRIBE THE ISSUE IN A WAY THAT IS UNDERSTANDABLE TO NEW CONTRIBUTORS. | ||
| YOU MUST NOT ASSUME THAT SUCH CONTRIBUTORS HAVE ANY KNOWLEDGE ABOUT THE CODEBASE OR HIERO. | ||
| IT IS HELPFUL TO ADD LINKS TO THE RELEVANT DOCUMENTATION AND/OR CODE SECTIONS. | ||
| BELOW IS AN EXAMPLE. | ||
| value: | | ||
| Edit here. Example provided below. | ||
|
|
||
| validations: | ||
| required: true | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| <!-- Example for problem (hidden in submission) --> | ||
| ## 👾 Description of the issue - Example | ||
|
|
||
| The example for Token Associate Transaction located at examples/tokens/token_associate_transaction.py can be improved. It correctly illustrates how to associate a token, however, it does so all from one function main() | ||
|
|
||
| As everything is grouped together in main(), it is difficult for a user to understand all the individual steps required to associate a token. | ||
|
|
||
| For example: | ||
| ```python | ||
|
|
||
| def run_demo(): | ||
| """Monolithic token association demo.""" | ||
| print(f"🚀 Connecting to Hedera {network_name} network!") | ||
| client = Client(Network(network_name)) | ||
| operator_id = AccountId.from_string(os.getenv("OPERATOR_ID", "")) | ||
| operator_key = PrivateKey.from_string(os.getenv("OPERATOR_KEY", "")) | ||
| client.set_operator(operator_id, operator_key) | ||
| print(f"✅ Client ready (operator {operator_id})") | ||
|
|
||
| test_key = PrivateKey.generate_ed25519() | ||
| receipt = ( | ||
| AccountCreateTransaction() | ||
| .set_key(test_key.public_key()) | ||
| .set_initial_balance(Hbar(1)) | ||
| .set_account_memo("Test account for token association demo") | ||
| .freeze_with(client) | ||
| .sign(operator_key) | ||
| .execute(client) | ||
| ) | ||
| if receipt.status != ResponseCode.SUCCESS: | ||
| raise Exception(receipt.status) | ||
| account_id = receipt.account_id | ||
| print(f"✅ Created test account {account_id}") | ||
|
|
||
| # Create tokens | ||
| tokens = [] | ||
| for i in range(3): | ||
| try: | ||
| receipt = ( | ||
| TokenCreateTransaction() | ||
| .set_token_name(f"DemoToken{i}") | ||
| .set_token_symbol(f"DTK{i}") | ||
| .set_decimals(2) | ||
| .set_initial_supply(100_000) | ||
| .set_treasury_account_id(operator_id) | ||
| .freeze_with(client) | ||
| .sign(operator_key) | ||
| .execute(client) | ||
| ) | ||
| if receipt.status != ResponseCode.SUCCESS: | ||
| raise Exception(receipt.status) | ||
| token_id = receipt.token_id | ||
| tokens.append(token_id) | ||
| print(f"✅ Created token {token_id}") | ||
| except Exception as e: | ||
| print(f"❌ Token creation failed: {e}") | ||
| sys.exit(1) | ||
|
|
||
| # Associate first token | ||
| try: | ||
| TokenAssociateTransaction().set_account_id(account_id).add_token_id(tokens[0]).freeze_with(client).sign(test_key).execute(client) | ||
| print(f"✅ Token {tokens[0]} associated with account {account_id}") | ||
| except Exception as e: | ||
| print(f"❌ Token association failed: {e}") | ||
| sys.exit(1) | ||
| ``` | ||
|
|
||
| - type: textarea | ||
| id: solution | ||
| attributes: | ||
| label: 💡 Proposed Solution | ||
| description: | | ||
| AT THIS SECTION YOU NEED TO DESCRIBE THE STEPS NEEDED TO SOLVE THE ISSUE. | ||
| PLEASE BREAK DOWN THE STEPS AS MUCH AS POSSIBLE AND MAKE SURE THAT THEY | ||
| ARE EASY TO FOLLOW. IF POSSIBLE, ADD LINKS TO THE RELEVANT | ||
| DOCUMENTATION AND/OR CODE SECTIONS. | ||
| value: | | ||
| Edit here. Example provided below. | ||
|
|
||
| validations: | ||
| required: true | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| <!-- Example for the solution (hidden in submission) --> | ||
| ## 💡 Solution - Example | ||
|
|
||
| For the TokenAssociateTransaction example, the solution is to split the monolithic main() function for illustrating TokenAssociateTransaction into separate smaller functions which are called from main(). | ||
| Such as: | ||
| - Setting up the client | ||
| - Creating an account | ||
| - Creating a token | ||
| - Associating the account to the token | ||
|
|
||
| - type: textarea | ||
| id: implementation | ||
| attributes: | ||
| label: 👩💻 Implementation Steps | ||
| description: | | ||
| AT THIS SECTION YOU NEED TO DESCRIBE THE TECHNICAL STEPS NEEDED TO SOLVE THE ISSUE. | ||
| PLEASE BREAK DOWN THE STEPS AS MUCH AS POSSIBLE AND MAKE SURE THAT THEY ARE EASY TO FOLLOW. | ||
| IF POSSIBLE, ADD LINKS TO THE RELEVANT DOCUMENTATION AND/OR CODE. | ||
| value: | | ||
| Edit here. Example provided below. | ||
|
|
||
| validations: | ||
| required: true | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| <!-- Example implementation (hidden in submission) --> | ||
| ### 👩💻 Implementation - Example | ||
|
|
||
| To break down the monolithic main function, you need to: | ||
| - [ ] Extract the Key Steps (set up a client, create a test account, create a token, associate the token) | ||
| - [ ] Copy and paste the functionality for each key step into its own function | ||
| - [ ] Pass to each function the variables you need to run it | ||
| - [ ] Call each function in main() | ||
| - [ ] Ensure you return the values you'll need to pass on to the next step in main | ||
| - [ ] Ensure the example still runs and has the same output! | ||
|
|
||
| For example: | ||
| ```python | ||
|
|
||
| def setup_client(): | ||
| """Initialize and set up the client with operator account.""" | ||
|
|
||
| def create_test_account(client, operator_key): | ||
| """Create a new test account for demonstration.""" | ||
|
|
||
| def create_fungible_token(client, operator_id, operator_key): | ||
| """Create a fungible token for association with test account.""" | ||
|
|
||
| def associate_token_with_account(client, token_id, account_id, account_key): | ||
| """Associate the token with the test account.""" | ||
|
|
||
| def main(): | ||
| client, operator_id, operator_key = setup_client() | ||
| account_id, account_private_key = create_test_account(client, operator_key) | ||
| token_id = create_fungible_token(client, operator_id, operator_key) | ||
| associate_token_with_account(client, token_id, account_id, account_private_key) | ||
| ``` | ||
|
|
||
| - type: textarea | ||
| id: acceptance-criteria | ||
| attributes: | ||
| label: ✅ Acceptance Criteria | ||
| description: | | ||
| EDIT OR EXPAND THE CHECKLIST ON WHAT IS REQUIRED TO BE ABLE TO MERGE A PULL REQUEST FOR THIS ISSUE | ||
| value: | | ||
| To be able to merge a pull request for this issue, we need: | ||
| - [ ] **Assignment:** You must be assigned to the issue, comment: `/assign` in the issue to get assigned [see guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/04_assigning_issues.md) | ||
| - [ ] **Changelog Entry:** Correct changelog entry [see guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/changelog_entry.md) | ||
| - [ ] **Signed commits:** commits must be DCO and GPG key signed [see guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/signing.md) | ||
| - [ ] **All Tests Pass:** our workflow checks like unit and integration tests must pass | ||
| - [ ] **Issue is Solved:** The implementation fully addresses the issue requirements as described above | ||
| - [ ] **No Further Changes are Made:** Code review feedback has been addressed and no further changes are requested | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: contribution_steps | ||
| attributes: | ||
| label: 📋 Step-by-Step Contribution Guide | ||
| description: Provide a contribution workflow suitable for new contributors | ||
| value: | | ||
| If you have never contributed to an open source project at GitHub, the following step-by-step guide will introduce you to the workflow. | ||
|
|
||
| - [ ] **Assignment:** You must be assigned to the issue, comment: `/assign` in the issue to get assigned [see guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/04_assigning_issues.md) | ||
| - [ ] **Fork, Branch and Work on the issue:** Create a copy of the repository, create a branch for the issue and solve the problem. For instructions, please read our [Contributing guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/CONTRIBUTING.md) file. Further help can be found at [Set-up Training](https://github.com/hiero-ledger/hiero-sdk-python/tree/main/docs/sdk_developers/training/setup) and [Workflow Training](https://github.com/hiero-ledger/hiero-sdk-python/tree/main/docs/sdk_developers/training/workflow). | ||
| - [ ] **DCO and GPG key sign each commit :** each commit must be -s and -S signed. An explanation on how to do this is at [Signing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/signing.md) | ||
| - [ ] **Add a Changelog Entry :** your pull request will require a changelog. Read [Changelog Entry Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/changelog_entry.md) to learn how. | ||
| - [ ] **Push and Create a Pull Request :** Once your issue is resolved, and your commits are signed, and you have a changelog entry, push your changes and create a pull request. Detailed instructions can be found at [Submit PR Training](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/training/workflow/11_submit_pull_request.md), part of [Workflow Training](https://github.com/hiero-ledger/hiero-sdk-python/tree/main/docs/sdk_developers/training/workflow). | ||
| - [ ] **You did it 🎉:** A maintainer or committer will review your pull request and provide feedback. If approved, we will merge the fix in the main branch. Thanks for being part of the Hiero community as an open-source contributor ❤️ | ||
|
|
||
| ***IMPORTANT*** You will ONLY be assigned to the issue if you comment: `/assign` | ||
| ***IMPORTANT*** Your pull request CANNOT BE MERGED until you add a changelog entry AND sign your commits each with `git commit -S -s -m "chore: your commit message"` with a GPG key setup. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: information | ||
| attributes: | ||
| label: 🤔 Additional Information | ||
| description: Provide any extra resources or context for contributors to solve this beginner issue | ||
| value: | | ||
| For more help, we have extensive documentation: | ||
| - [SDK Developer Docs](https://github.com/hiero-ledger/hiero-sdk-python/tree/main/docs/sdk_developers) | ||
| - [SDK Developer Training](https://github.com/hiero-ledger/hiero-sdk-python/tree/main/docs/sdk_developers/training) | ||
|
|
||
| Additionally, we invite you to join our community on our [Discord](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/discord.md) server. | ||
|
|
||
| We also invite you to attend each Wednesday, 2pm UTC our [Python SDK Office Hour and Community Calls](https://zoom-lfx.platform.linuxfoundation.org/meetings/hiero?view=week). The Python SDK Office hour is for hands-on-help and the Community Call for general community discussion. | ||
|
|
||
| You can also ask for help in a comment below! | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.