crisishistory/HistoryAIToolkit

Improve "Getting Started" instructions

Open

#44 geöffnet am 4. Okt. 2023

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (18 Forks)github user discovery
documentationhacktoberfest-acceptedhelp wanted

Repository-Metriken

Stars
 (13 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

  • Move the getting started section from the readme into its own file in the docs folder
  • Link to the new getting started file in the docs folder once created, from other places that reference it:
  • Try them out and make corrections as needed

Contributor Guide

Research-Richtung
Verschieben Sie den Abschnitt 'Erste Schritte' von README.md in eine neue Datei in docs/ (z. B. docs/getting started.md). Aktualisieren Sie alle Verweise: README.md, CONTRIBUTING.md und die Indexseite von ReadTheDocs (docs/index.rst oder ähnlich). Überprüfen Sie die Links und testen Sie die Anweisungen.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85