Skip to content

[task] Add a first-PR example to contributing docs #28

Closed as not planned

Description

@phongndo

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.md only if the example needs to stay aligned with the template

Depends on

None. This can be claimed immediately.

Out of scope

  • Do not change the PR template checklist unless a maintainer asks for it.
  • Do not add a long tutorial for GitHub pull requests.
  • Do not weaken the human-authored PR requirement.

Definition of done

  • Contributing docs include a short example PR description for a small docs issue.
  • The example includes summary, linked issue, verification commands, and notes for reviewers.
  • The example keeps the human-authored PR expectation clear.

Verification

  • pnpm format:prettier:check
  • Manually review the rendered Markdown or GitHub preview for readability.

Contributor notes

This is a good first issue because it improves contributor guidance without touching product code.

Activity

  1. added
    good first issueA scoped task that is suitable for a first contribution.
    area: docsProject documentation and contributor guidance.
    kind: docsDocumentation-only changes or issues.
    good for beginnerA student-friendly starter task with clear scope, success criteria, and verification steps.
    on Apr 29, 2026
  2. Za1dKhan commented on May 9, 2026

    @Za1dKhan

    /claim

  3. github-actions commented on Jun 8, 2026

    @github-actions

    This issue has been quiet for a while. If it is still relevant, add context and it will stay open.

  4. github-actions commented on Jun 15, 2026

    @github-actions

    Closing due to prolonged inactivity. It can be reopened with fresh context.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: docsProject documentation and contributor guidance.good first issueA scoped task that is suitable for a first contribution.good for beginnerA student-friendly starter task with clear scope, success criteria, and verification steps.kind: docsDocumentation-only changes or issues.status: staleAutomatically marked stale due to inactivity.

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions