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

Great README examples (documentation, markdown)

Aperta
#11 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
markdown
Ambito
documentation

Direzione di ricerca

Inizia esaminando il README corrente del repository confrontandolo con gli esempi collegati nell'issue. L'issue non indica alcun file di destinazione, modifiche specifiche o criteri di accettazione, quindi definisci l'ambito del README e una checklist misurabile per il completamento prima di iniziare.

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

Descrizione

What should a README be?

Projects should have READMEs that have

  • Easy to understand the purpose
  • At-a-glance visual usage / demo
  • Actual demo
  • Easy deploy instructions

Great READMEs

Master Markdown

(honestly, it's easy)

Lingua principale
JavaScript
Stelle
63
Fork
3
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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 BeyondCodeBootcamp/beyondcodebootcamp

Tutte le issue di BeyondCodeBootcamp/beyondcodebootcamp

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.