Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Rewrite README for a public audience

Aperta Adatta ai principianti
  • Qualcosa non va?
#94 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
github, typescript
Ambito
documentation

Direzione di ricerca

Inizia da README.md e dal CONTRIBUTING.md esistente, oltre che dal sito della documentazione collegato dal progetto. Poi verifica che link e dettagli siano corretti per la configurazione con un solo comando, la roadmap di GitHub Project, CI, la licenza e l’ultima release. Riscrivi il README per chi legge il progetto per la prima volta, includendo le sezioni indicate su panoramica, demo, avvio rapido, funzionalità e architettura, stato, link per contribuire, crediti e badge. Il lavoro è completo quando i lettori possono capire e provare il progetto e trovare aiuto in meno di un minuto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

type: docs

Goal

Rewrite README.md for people who have never heard of the project.

Contents

  • One-paragraph pitch and a screenshot or short demo of a review comment.
  • What it does and does not do (GitHub only for now, PR-Agent engine, bring your own LLM key).
  • Quick start (link to the one-command setup) and a link to the docs site.
  • Feature overview: automatic reviews, comment commands, web UI, projects and settings.
  • Architecture in a few lines and a diagram.
  • Status (beta), roadmap link (GitHub Project), how to contribute, license, and credits for PR-Agent.
  • Badges: CI, license, latest release.

Acceptance criteria

A reader understands what the project is, how to try it, and where to ask for help within a minute. Developer-only details move to CONTRIBUTING.md and the docs.

Lingua principale
TypeScript
Stelle
0
Fork
1
Merge medio
1h 15m
PR unite (30g)
217

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ExpidetGames/code-reviewer

Tutte le issue di ExpidetGames/code-reviewer

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.