docs: add "pick your first issue" to CONTRIBUTING

Open Beginner friendly
  • Is something wrong?
#181 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
bun, typescript
Domain
developer-experience, documentation

Research direction

Read CONTRIBUTING.md and locate the section before “Pull requests.” Add the requested guidance in fewer than ten lines, then run bun run check and confirm the contributor quickstart job passes. Done means both checks pass and the new section covers the good first issue label, commenting before starting, and the stated maintainer response time.

Written by the indexing model from the issue text.

Description

documentation good first issue

CONTRIBUTING.md explains setup and the checks, but not how to find a first task.

What to do

  • Add a short section before "Pull requests" that says: filter issues by the good first issue label,
    comment on the issue before you start, and that maintainers answer within a few days.
  • Keep it under ten lines.

Done when bun run check and the contributor quickstart job pass.

Dominant language
TypeScript
Stars
1
Forks
0
Avg merge
2h 45m
Merged PRs (30d)
64

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rel-kit/relkit

All issues in rel-kit/relkit

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.