-
Notifications
You must be signed in to change notification settings - Fork 2
[task] Add a first-PR example to contributing docs #28
Copy link
Copy link
Open
Labels
area: docsProject documentation and contributor guidance.Project documentation and contributor guidance.good first issueA scoped task that is suitable for a first contribution.A scoped task that is suitable for a first contribution.good for beginnerA student-friendly starter task with clear scope, success criteria, and verification steps.A student-friendly starter task with clear scope, success criteria, and verification steps.kind: docsDocumentation-only changes or issues.Documentation-only changes or issues.
Milestone
Metadata
Metadata
Assignees
Labels
area: docsProject documentation and contributor guidance.Project documentation and contributor guidance.good first issueA scoped task that is suitable for a first contribution.A scoped task that is suitable for a first contribution.good for beginnerA student-friendly starter task with clear scope, success criteria, and verification steps.A student-friendly starter task with clear scope, success criteria, and verification steps.kind: docsDocumentation-only changes or issues.Documentation-only changes or issues.
Area
Docs
Goal
Add a small example PR description for a first-time contributor opening a focused docs change.
Why this matters
The PR template lists what to include, but a concrete example helps students turn a completed issue into a clear reviewable pull request.
Relevant files
CONTRIBUTING.md.github/PULL_REQUEST_TEMPLATE.mdonly if the example needs to stay aligned with the templateDepends on
None. This can be claimed immediately.
Out of scope
Definition of done
Verification
pnpm format:prettier:checkContributor notes
This is a good first issue because it improves contributor guidance without touching product code.