Skip to content

Commit 80df574

Browse files
Docs: add contributor thanks and GFI criteria to good-first-issue template
Signed-off-by: prishajaiswal75 <prisha.jaiswal.btech2023@sitpune.edu.in>
1 parent 19352d0 commit 80df574

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

.github/ISSUE_TEMPLATE/01_good_first_issue.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,33 @@ body:
3131
validations:
3232
required: true
3333

34+
- type: markdown
35+
attributes:
36+
value: |
37+
---
38+
**Thanks for contributing!**
39+
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.
40+
---
41+
- type: markdown
42+
attributes:
43+
value: |
44+
### Good First Issue (GFI) — What we accept
45+
We usually accept small, focused contributions that can be validated with an existing test or simple change. Examples include:
46+
- Small string / formatting fixes (e.g., `__repr__`, `__str__` changes)
47+
- Typing or return-type hint fixes
48+
- Small refactors of existing examples (splitting monolithic examples into functions)
49+
- Improvements to example documentation or inline comments
50+
- Small, local changes that do not require cross-module knowledge
51+
- Additions or clarifications to docstrings or function comments
52+
53+
### What we usually *do not* accept as GFI
54+
- Creation of large new examples or heavy new features
55+
- New integration tests or large test suites
56+
- Changes requiring deep knowledge across multiple subsystems
57+
- Changes to core protocol/serialization functions
58+
59+
For a more detailed guide, see `docs/maintainers/good_first_issues.md` (once available).
60+
3461
- type: markdown
3562
attributes:
3663
value: |

0 commit comments

Comments
 (0)