lsd-rs/lsd

Improve the documentation

Offen

#120 geöffnet am 09.02.2019

Auf GitHub ansehen
 (1 Kommentar) (2 Reaktionen) (0 zugewiesene Personen)Rust (434 Forks)batch import
help wantedkind/enhancement

Repository-Metriken

Stars
 (13.400 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 34T 3h) (2 gemergte PRs in 30 T)

Beschreibung

It would be great to have a FAQ or a Known Issues section into the README. The possible content would be:

  • The terminal related bugs with the icons (#118).
  • How to configure properly the terminal font (#117)
  • Some documentation about the default configuration (#113)
  • The snap without --classic "bug" (#127 )

Contributor Guide

Research-Richtung
Überprüfen Sie die referenzierten Issues und fügen Sie dem README basierend auf häufigen Fragen einen FAQ oder Bekannte Probleme Abschnitt hinzu.
Tech Stack
rust
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
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
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
95