Skip to content

Conversation

@prishajaiswal75
Copy link

@prishajaiswal75 prishajaiswal75 commented Dec 12, 2025

Summary:
This PR improves the Good First Issue template by adding:

  • A short thanks/welcome message for contributors.
  • A clear list of criteria describing what we accept as Good First Issues and what we do not accept.

These additions should help first-time contributors craft higher-quality GFI reports and help maintainers triage faster.

Changes:

  • Insert two markdown blocks into .github/ISSUE_TEMPLATE/01_good_first_issue.yml:
    • A welcoming "Thanks for contributing" section.
    • A "GFI criteria" section with examples of acceptable and non-acceptable GFI tasks.

Notes:

  • Docs-only change; no code is modified.
  • Happy to adjust wording or placement if maintainers prefer a different layout.

Fixes #1052

@github-actions
Copy link

[commit-verification-bot]
Hi, this is VerificationBot.
Your pull request cannot be merged as it has unverified commits.
View your commit verification status: Commits Tab.

To achieve verified status, please read:

Remember, you require a GPG key and each commit must be signed with:
git commit -S -s -m "Your message here"

Thank you for contributing!

From the Hiero Python SDK Team

@github-actions
Copy link

Hi, this is WorkflowBot.
Your pull request cannot be merged as it is not passing all our workflow checks.
Please click on each check to review the logs and resolve issues so all checks pass.
To help you:

@prishajaiswal75 prishajaiswal75 marked this pull request as draft December 12, 2025 12:21
@prishajaiswal75 prishajaiswal75 changed the title Docs: expand good-first-issue template with contributor thanks and checklist docs: update good first issue template with welcome + criteria Dec 12, 2025
@prishajaiswal75 prishajaiswal75 marked this pull request as ready for review December 12, 2025 12:23
@prishajaiswal75 prishajaiswal75 marked this pull request as draft December 12, 2025 12:27
@prishajaiswal75 prishajaiswal75 marked this pull request as ready for review December 12, 2025 12:27
@prishajaiswal75 prishajaiswal75 force-pushed the docs/expand-good-first-issue-template branch from 74b5824 to a965469 Compare December 12, 2025 12:30
@prishajaiswal75 prishajaiswal75 changed the title docs: update good first issue template with welcome + criteria docs: update good first issue template with welcome + criteria #1052 Dec 12, 2025
@prishajaiswal75 prishajaiswal75 changed the title docs: update good first issue template with welcome + criteria #1052 docs: update good first issue template with welcome + criteria Dec 12, 2025
Copy link
Contributor

@exploreriii exploreriii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @prishajaiswal75
Please test this as described on your fork, merging to main and trying to create an issue - see if the template renders :)

Additionally your signing is not correct, please follow the instructions at docs/sdk_developers/signing.md, thanks!

@exploreriii exploreriii marked this pull request as draft December 12, 2025 12:42
@prishajaiswal75 prishajaiswal75 marked this pull request as ready for review December 12, 2025 12:49
…plate

Signed-off-by: prishajaiswal75 <prisha.jaiswal.btech2023@sitpune.edu.in>
@prishajaiswal75 prishajaiswal75 force-pushed the docs/expand-good-first-issue-template branch from a965469 to 80df574 Compare December 12, 2025 12:51
@prishajaiswal75
Copy link
Author

Hi @prishajaiswal75 Please test this as described on your fork, merging to main and trying to create an issue - see if the template renders :)

Additionally your signing is not correct, please follow the instructions at docs/sdk_developers/signing.md, thanks!

Hi @exploreriii
I merged the branch into my fork’s main and confirmed the Good First Issue template renders on the New Issue page on my fork.
I also re-signed the commit and pushed the amended commit (GPG + DCO). Please let me know if you want any wording/placement changes happy to adjust. Thanks!

@exploreriii
Copy link
Contributor

Hi @prishajaiswal75
Screenshot 2025-12-12 at 15 16 40
Please add a link to your template tested out 👍
I can't see you have added an issue page, so i can't know if it works

@exploreriii exploreriii marked this pull request as draft December 12, 2025 15:17
@prishajaiswal75
Copy link
Author

Hi @exploreriii
Issues are now enabled on my fork.
Here is the tested Good First Issue template link: https://github.com/prishajaiswal75/hiero-sdk-python/issues/new?template=01_good_first_issue.yml

The template renders correctly. Please review and let me know if you’d like any adjustments or corrections :)

@prishajaiswal75 prishajaiswal75 marked this pull request as ready for review December 13, 2025 04:23
Copy link
Contributor

@exploreriii exploreriii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for creating a mock on your fork :D

There are a couple of issues -

https://github.com/prishajaiswal75/hiero-sdk-python/issues/new?template=01_good_first_issue.yml

Firstly,

this text should be smaller than
"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 Good First Issue (GFI) : a small, well-scoped task that helps new contributors learn the codebase and workflow.
"

this text
"Thanks for contributing 😊"

Secondly,

There should be a space between
"We usually accept narrow, well-scoped contributions that rely on general Python skills and can be validated using an existing test."
and
"Examples include:"

Thirdly, all this new content is below description of the issue!
As mentioned in the pull request, it should be

Thanks for contributing section -> First Timers only -> What we accept -> Description of issue

Furthermore, as a bonus, if you are able please think how to make this new section a little easier to see

@exploreriii exploreriii marked this pull request as draft December 13, 2025 06:53
@prishajaiswal75 prishajaiswal75 marked this pull request as ready for review December 13, 2025 13:42
@prishajaiswal75
Copy link
Author

Thanks for creating a mock on your fork :D

There are a couple of issues -

https://github.com/prishajaiswal75/hiero-sdk-python/issues/new?template=01_good_first_issue.yml

Firstly,

this text should be smaller than "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 Good First Issue (GFI) : a small, well-scoped task that helps new contributors learn the codebase and workflow. "

this text "Thanks for contributing 😊"

Secondly,

There should be a space between "We usually accept narrow, well-scoped contributions that rely on general Python skills and can be validated using an existing test." and "Examples include:"

Thirdly, all this new content is below description of the issue! As mentioned in the pull request, it should be

Thanks for contributing section -> First Timers only -> What we accept -> Description of issue

Furthermore, as a bonus, if you are able please think how to make this new section a little easier to see

Thanks for the feedback! I've implemented all the changes:

  1. Made the "Thanks" heading smaller
  2. Added spacing between paragraphs and tried to make it an easy read
  3. Moved sections to correct order
    Added an IMPORTANT alert box to make guidelines more prominent

Updated preview: https://github.com/prishajaiswal75/hiero-sdk-python/issues/new?template=01_good_first_issue.yml

Let me know if this looks good or if you'd like any more adjustments or corrections :)

- Changes requiring deep knowledge across multiple subsystems
- Changes to core protocol/serialization functions
For a more detailed guide, see `docs/maintainers/good_first_issues.md` (once available).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please update link to
For a more detailed guide, see docs/maintainers/good_first_issues_guidelines.md

attributes:
value: |
---
**Thanks for contributing!**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Format
Thanks for Contributing

so its larger than

    We really appreciate your time and help. If this is your first open-source contribution, welcome — we've written this template to help you create a good first issue (GFI). Good first issues are small, well-scoped tasks that newcomers can complete to learn the codebase and the contribution workflow.

→ very large

→ good section header (recommended here)

→ smaller section header

for example
---
## Thanks for contributing!

  We really appreciate your time and help. If this is your first open-source contribution, welcome — we've written this template to help you create a good first issue (GFI). Good first issues are small, well-scoped tasks that newcomers can complete to learn the codebase and the contribution workflow.
  ---

might work

@exploreriii exploreriii marked this pull request as draft December 13, 2025 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expand .github/ISSUE_TEMPLATE/01_good_first_issue.yml to include Thanks & GFI Criteria

2 participants