Add a “Good First PR” checklist to README

Open Beginner friendly
#65 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
next.js, tailwindcss, typescript
Domain
documentation

Research direction

Open the README and find the contributor or pull request guidance. Add the provided “Good First PR Checklist” with steps for running the app locally, keeping changes focused, updating docs when behavior changes, and writing a clear PR title and description; done means the checklist is visible and accurately formatted.

Written by the indexing model from the issue text.

Description

documentation good first issue triage

Good First PR Checklist

Before opening a pull request:

  • Run the app locally
  • Keep the change small and focused
  • Update docs if behavior changed
  • Write a clear PR title and description
Dominant language
TypeScript
Stars
71
Forks
188
No merged PRs in 30d

Contributor guide

Open the contributing guide

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 github-samples/gitfolio

All issues in github-samples/gitfolio

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.