-
Notifications
You must be signed in to change notification settings - Fork 7
docs: add a worked curriculum contribution guide #39
Copy link
Copy link
Open
Labels
area: curriculumCurriculum exercises, checks, and solutionsCurriculum exercises, checks, and solutionsdev sprintPythonlings Community Dev Sprint August 2026Pythonlings Community Dev Sprint August 2026documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomerssize: MMedium, self-contained contributionMedium, self-contained contribution
Description
Metadata
Metadata
Assignees
Labels
area: curriculumCurriculum exercises, checks, and solutionsCurriculum exercises, checks, and solutionsdev sprintPythonlings Community Dev Sprint August 2026Pythonlings Community Dev Sprint August 2026documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomerssize: MMedium, self-contained contributionMedium, self-contained contribution
Motivation
Curriculum contributions touch several aligned trees and hidden checks. A worked path makes the real contract approachable to a first-time contributor while protecting learner-facing quality.
Current evidence
exercises/,checks/,solutions/, andinfo.toml.Readme.mdmentions the mirrored exercise/check filenames but does not provide an end-to-end worked contribution walkthrough.tests/integration/test_solution_verify.py.Exact scope
Add a linked guide that walks through one representative curriculum contribution: learner exercise, hidden check, direct solution, hint and docs metadata, naming, hidden-check quality, and verification. Keep the example Python 3.9 compatible.
Acceptance checklist
exercises/,checks/,solutions/, andinfo.toml.Explicit exclusions
Do not add or change an actual exercise, weaken hidden-check isolation, migrate solution stubs, or redesign the curriculum.
Likely files
docs-site/contributing.mddocs-site/curriculum-contribution-guide.md(new)mkdocs.ymlVerification
Manually verify that the example paths and commands exist and that the guide does not expose production hidden checks.
Sprint coordination
See the sprint Discussion. This issue is unassigned and is not a reservation.