jackMort/ChatGPT.nvim

Improve Documentation

Open

#91 geöffnet am 6. März 2023

Auf GitHub ansehen
 (8 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Lua (323 Forks)batch import
help wanted

Repository-Metriken

Stars
 (4.005 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

Document all the flows and config options, add some actions examples

Contributor Guide

Research-Richtung
Beginnen Sie mit der Überprüfung der vorhandenen README und Dokumentation im Repository. Überprüfen Sie den Quellcode im Verzeichnis `lua/`, um alle Konfigurationsoptionen und Abläufe zu identifizieren. Achten Sie auf die Kommentare in Issue #91 für spezifische Bereiche, die verbessert werden müssen. Erwägen Sie, eine neue Dokumentationsdatei hinzuzufügen oder die README mit schrittweisen Nutzungsbeispielen zu aktualisieren.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Recherche nötig
Voraussetzungen
Familiarity with ChatGPT.nvim pluginBasic Neovim knowledge
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60