Skip to content

[Good First Issue]: Rename some github templates to match the upstream names #1430

@exploreriii

Description

@exploreriii

🆕🐥 First Timers Only

This issue is reserved for people who have never contributed or have made minimal contributions to Hiero Python SDK.
We know that creating a pull request (PR) is a major barrier for new contributors.
The goal of this issue and all other issues in find a good first issue is to help you make your first contribution to the Hiero Python SDK.

👾 Description of the issue

There is a new workflow upstream at hiero which helps us to keep our templates in sync with the upstream templates
https://github.com/hiero-ledger/.github/pull/48/changes

For this to work, we need all the templates we use from upstream to match the name exactly
https://github.com/hiero-ledger/.github/tree/main/.github/ISSUE_TEMPLATE

Currently ours have a number, theirs do not
https://github.com/hiero-ledger/hiero-sdk-python/tree/main/.github/ISSUE_TEMPLATE

💡 Proposed Solution

Rename the templates we use from upstream exactly how they are upstream which is

  • bug
  • feature request

👩‍💻 Implementation Steps

Rename:
02_bug_report.yml ---> bug.yml
03_feature_request.yml ---> feature.yml

as a result, the numbering will be totally off so we need to rename:
04_good_first_issue.yml --> 02_good_first_issue.yml
05_beginner_issue.yml --> 03_beginner_issue.yml
06_intermediate_issue.yml --> 04_intermediate_issue.yml
07_advanced_issue.yml --> 05_advanced_issue.yml

PLEASE CHECK by using the search icons in VS code, any documents pointing to these files have the names and URLs updated.

✅ Acceptance Criteria

To be able to merge a pull request for this issue, we need:

  • Assignment: get assigned by commenting /assign see guide
  • Changelog Entry: Correct changelog entry see guide
  • Signed commits: commits must be DCO and GPG key signed see guide
  • 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

📋 Step-by-Step Contribution Guide

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: get assigned by commenting /assign see guide
  • 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 file. Further help can be found at Set-up Training and Workflow Training.
  • 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
  • Add a Changelog Entry : your pull request will require a changelog. Read Changelog Entry Guide 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, part of Workflow Training.
  • 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.

🤔 Additional Information

For more help, we have extensive documentation attributes:

Additionally, we invite you to join our community on our Discord server.

We also invite you to attend each Wednesday, 2pm UTC our Python SDK Office Hour and Community Calls. 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!

Metadata

Metadata

Assignees

Labels

Good First IssueIssues which are ideal for a first time or new project contributor.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions