-
Notifications
You must be signed in to change notification settings - Fork 108
docs: update good first issue template with welcome + criteria #1057
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
base: main
Are you sure you want to change the base?
docs: update good first issue template with welcome + criteria #1057
Conversation
|
[commit-verification-bot] To achieve verified status, please read: Remember, you require a GPG key and each commit must be signed with: Thank you for contributing! From the Hiero Python SDK Team |
|
Hi, this is WorkflowBot.
|
74b5824 to
a965469
Compare
exploreriii
left a comment
There was a problem hiding this 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!
…plate Signed-off-by: prishajaiswal75 <prisha.jaiswal.btech2023@sitpune.edu.in>
a965469 to
80df574
Compare
Hi @exploreriii |
|
Hi @prishajaiswal75 |
|
Hi @exploreriii The template renders correctly. Please review and let me know if you’d like any adjustments or corrections :) |
exploreriii
left a comment
There was a problem hiding this 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
Thanks for the feedback! I've implemented all the changes:
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). |
There was a problem hiding this comment.
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!** |
There was a problem hiding this comment.
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

Summary:
This PR improves the Good First Issue template by adding:
These additions should help first-time contributors craft higher-quality GFI reports and help maintainers triage faster.
Changes:
Notes:
Fixes #1052