Create guidelines for README Files
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 30/100
- Issue-Typ
- Dokumentation
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- markdown
- Bereich
- documentation
Rechercherichtung
Überprüfe zuerst die README-Dateien des Repositorys und seine Docusaurus/Markdown-Struktur und vergleiche sie anschließend mit relevanten Best Practices der Community. Definiere die standardisierte README-Struktur und dokumentiere die Richtlinien, damit wesentliche Informationen in allen AboutCode-Projekten einheitlich sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Create a standardized structure for README files across AboutCode projects, aligning with community best practices. By developing a consistent format, we can enhance clarity, improve user onboarding, and ensure that essential information is easily accessible.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 9
- Forks
- 17
- Ø Merge
- 7 Std. 55 Min.
- Gemergte PRs (30 T.)
- 2
Entwicklungsumgebung
Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus aboutcode-org/www.aboutcode.org
-
Making all post button.Evtl. vergeben @sarthaklole hat das vor 73 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
aboutcode-org/www.aboutcode.org#117 · 3 Kommentare ·
-
WWW: Reduce frequency of update-releasesEvtl. wieder frei @johnmhoran hat das vor 54 Tagen übernommen, und es ist kein Pull Request offen. Offenci-workflow
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 45/100
aboutcode-org/www.aboutcode.org#180 · 1 zugewiesene Person ·
-
DOCS: Create new AboutCode stack diagram(s)Evtl. wieder frei @hixvikas hat das vor 55 Tagen übernommen, und es ist kein Pull Request offen. Offendocumentation
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 35/100
aboutcode-org/www.aboutcode.org#166 · 1 Kommentar ·
-
WWW: Create About top level page?Evtl. vergeben @pombredanne hat das vor 157 Tagen übernommen. Offenwebsite
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 35/100
aboutcode-org/www.aboutcode.org#164 · 1 Reaktion · 1 zugewiesene Person ·
-
WWW: Add Initiatives and grant ProjectsEvtl. wieder frei @mjherzog hat das vor 243 Tagen übernommen, und es ist kein Pull Request offen. Offenenhancement needs design website
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
aboutcode-org/www.aboutcode.org#141 · 1 zugewiesene Person ·
Alle Issues in aboutcode-org/www.aboutcode.org
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
hexlet-codebattle/codebattle#2374 ·
-
docs: Code on siteOffen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
saadeghi/daisyui#4846 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 4 Tagen
-
spec-feedback
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 78/100
Maintainer antworten meist innerhalb von 1 Tag
-
automated-link-issue broken-link
Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 65/100
JuanPabloDiaz/freeForGeeks#313 ·