You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/01_good_first_issue.yml
+41Lines changed: 41 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,15 @@ title: "[Good First Issue]: "
4
4
labels: ["Good First Issue"]
5
5
assignees: []
6
6
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
+
---
7
16
- type: textarea
8
17
id: intro
9
18
attributes:
@@ -16,6 +25,38 @@ body:
16
25
validations:
17
26
required: false
18
27
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`.*
Copy file name to clipboardExpand all lines: CHANGELOG.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,9 +36,9 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
36
36
- Add PR inactivity reminder bot for stale pull requests `.github/workflows/pr-inactivity-reminder-bot.yml`
37
37
- Add comprehensive training documentation for _Executable class `docs/sdk_developers/training/executable.md`
38
38
- 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)
39
40
40
41
### Changed
41
-
42
42
- 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)
43
43
- Allow `PublicKey` for `TokenUpdateKeys` in `TokenUpdateTransaction`, enabling non-custodial workflows where operators can build transactions using only public keys (#934).
0 commit comments