Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Great README examples (documentation, markdown)

Offen
#11 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
25/100
Issue-Typ
Dokumentation
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
markdown
Bereich
documentation

Rechercherichtung

Beginne damit, die aktuelle README des Repositorys mit den im Issue verlinkten Beispielen abzugleichen. Das Issue nennt keine Zieldatei, keine konkreten Änderungen und keine Akzeptanzkriterien. Lege daher den Umfang der README und eine messbare Checkliste für den Abschluss fest, bevor du beginnst.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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)

Vorherrschende Sprache
JavaScript
Sterne
63
Forks
3
Keine gemergten PRs in 30 T.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus BeyondCodeBootcamp/beyondcodebootcamp

Alle Issues in BeyondCodeBootcamp/beyondcodebootcamp

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.