Skip to content

Commit 996db4f

Browse files
docs: update good first issue template with welcome + criteria (#1057)
Signed-off-by: prishajaiswal75 <[email protected]>
1 parent cfa37d1 commit 996db4f

File tree

2 files changed

+43
-1
lines changed

2 files changed

+43
-1
lines changed

.github/ISSUE_TEMPLATE/01_good_first_issue.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ title: "[Good First Issue]: "
44
labels: ["Good First Issue"]
55
assignees: []
66
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
---
11+
## **Thanks for contributing!** 😊
12+
13+
We truly appreciate your time and effort. If this is your first open-source contribution, welcome!
14+
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.
15+
---
716
- type: textarea
817
id: intro
918
attributes:
@@ -16,6 +25,38 @@ body:
1625
validations:
1726
required: false
1827

28+
- type: markdown
29+
attributes:
30+
value: |
31+
> [!IMPORTANT]
32+
> ### 📋 Good First Issue (GFI) Guidelines
33+
>
34+
> **What we generally consider good first issues:**
35+
>
36+
> - **Narrow changes or additions to `src` functionality** that use generic Python skills which can be tested by adding to an existing test. For example:
37+
> - `__str__` functions
38+
> - `__repr__` functions
39+
> - Typing fixes, like return type hints or basic type conflicts
40+
> - **Refactors of existing examples:**
41+
> - Separating existing examples into separate functions
42+
> - Or, conversely, taking a split example into a monolithic function
43+
> - **Improvements to documentation** in examples and source code:
44+
> - Docstrings: module docstrings, function docstrings
45+
> - Inline comments
46+
> - Addition or changes to print statements to improve clarity
47+
> - **Functional improvements to examples:**
48+
> - Additional steps that would help to illustrate functionality
49+
> - **Specific additions to existing unit or integration tests**
50+
>
51+
> **What we generally do NOT consider good first issues:**
52+
>
53+
> - Creation of new examples
54+
> - Creation of new unit and integration tests
55+
> - Changes to DLT functionality, like `to_proto` and `from_proto`
56+
> - Anything requiring knowledge of multiple areas of the codebase
57+
>
58+
> 📖 *For a more detailed explanation, refer to `docs/maintainers/good_first_issues_guidelines.md`.*
59+
1960
- type: textarea
2061
id: issue
2162
attributes:

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
3636
- Add PR inactivity reminder bot for stale pull requests `.github/workflows/pr-inactivity-reminder-bot.yml`
3737
- Add comprehensive training documentation for _Executable class `docs/sdk_developers/training/executable.md`
3838
- Added empty `docs/maintainers/good_first_issues.md` file for maintainers to write Good First Issue guidelines (#1034)
39+
- Enhanced `.github/ISSUE_TEMPLATE/01_good_first_issue.yml` with welcoming message and acceptance criteria sections to guide contributors in creating quality GFIs (#1052)
3940

4041
### Changed
41-
4242
- Refactored `account_create_transaction_with_fallback_alias.py` by splitting the monolithic `create_account_with_fallback_alias` function into modular functions: `generate_fallback_key`, `fetch_account_info`, and `print_account_summary`. The existing `setup_client()` function was reused for improved readability and structure (#1018)
4343
- Allow `PublicKey` for `TokenUpdateKeys` in `TokenUpdateTransaction`, enabling non-custodial workflows where operators can build transactions using only public keys (#934).
4444
- Bump protobuf toml to protobuf==6.33.2
@@ -619,3 +619,4 @@ contract_call_local_pb2.ContractLoginfo -> contract_types_pb2.ContractLoginfo
619619
### Removed
620620

621621
- N/A
622+

0 commit comments

Comments
 (0)