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
Welcome! This is a Beginner Issue designed to help you learn the codebase.
π When this issue is complete, you will have:
β Researched a file or method in detail
β Followed SDK patterns to implement a solution
β Researched and identified appropriate programming constructs to solve the problem
β Created basic tests
β Delivered a clean, review-ready pull request
Beginner issues are low-risk but we expect a working solution.
Important
We recommend completing at least 3 good first issues before attempting a beginner issue.
Difficulty:
Requires building knowledge of the specific file(s)
Beginner to intermediate Coding skills
Tip
You should be comfortable with:
Forking, branching, committing (with DCO + GPG signing), and opening a pull request without a tutorial
Reading beginner to intermediate code you did not write and following its patterns
Handling simple merge conflicts
Keeping your fork up to date with main by rebasing
Looking things up on your own before asking for help
If any of that feels unfamiliar, good first issues might still be the most rewarding path for you right now β find one here.
You can always come back when you are ready.
β οΈ AI Usage Policy
AI can help you understand the codebase and the problem
Using AI to generate code for beginner issues is strictly discouraged
Using AI as the main source of research is strictly discouraged, refer to language and library documentation, protobuf definitions and other SDKs.
π§βπ Beginner Issue
Welcome! This is a Beginner Issue designed to help you learn the codebase.
π When this issue is complete, you will have:
β Researched a file or method in detail
β Followed SDK patterns to implement a solution
β Researched and identified appropriate programming constructs to solve the problem
β Created basic tests
β Delivered a clean, review-ready pull request
π Problem Description
π‘ Expected Solution
π Research Pointers
π οΈ Implementation Notes
π§ Beginner Contributors β Prerequisites & Expectations
Caution
Beginner issues are low-risk but we expect a working solution.
Important
We recommend completing at least 3 good first issues before attempting a beginner issue.
Difficulty:
Tip
You should be comfortable with:
If any of that feels unfamiliar, good first issues might still be the most rewarding path for you right now β find one here.
You can always come back when you are ready.
β±οΈ Timeline & Workflow
Typical time: ~1 Week / ~8 hours.
π§© Difficulty: Manageable but requires investigation and testing
π Best for: Beginner contributors
π΄ Completing a beginner issue in 1β3 hours is a red flag.
Tip
Suggested: share your proposed implementation approach as a comment before writing code to get early feedback and avoid wasted effort.
π§ͺ Testing Requirements
Important
At the beginner level, testing will be necessary but a small component.
The methods you implement should be verified (happy path at least)
How you test depends on the type of change.
Source code changes (e.g. in
src/):uv run pytest tests/unit/<specific_file>_test.py -vGitHub Actions / workflow changes (e.g. in
.github/): Guidemainand simulating the scenarioExample script changes (e.g. in
examples/):π‘οΈ Quality & Review Standards
Beginner PRs must be working and follow best practices.
π€ AI notes
β PR Quality Checklist
Before opening your PR, confirm:
Before requesting a review, confirm:
git commit -S -s -m "chore: description"β Signing guide[Unreleased]β Changelog guideπ Workflow quick reference
You have done this before β here are the links if you need them:
/assignbelowπ Resources & Support
π Stuck?
Tip
Comment on this issue: and describe what you have tried. A maintainer will respond.
Python SDK References:
References: