NixOS/nix

Move examples in classic commands closer to the top

Offen

#10.717 geöffnet am 14.05.2024

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (1.293 Forks)batch import
documentationgood first issue

Repository-Metriken

Stars
 (9.803 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 7T 11h) (83 gemergte PRs in 30 T)

Beschreibung

Problem

Command line examples for classic commands are at the very bottom of each manual page, which makes them hard to discover after reams of generic options.

Proposal

Move them right after the description, as with the experimental commands.

Checklist

Priorities

Add :+1: to issues you find important.

Contributor Guide

Research-Richtung
Finde die Handbuch Quelldateien im Repository (wahrscheinlich unter doc/manual/src), lokalisiere die Seiten für klassische Befehle und verschiebe die Beispielblöcke vom unteren Ende direkt nach dem Beschreibungsabschnitt, analog zum Layout der experimentellen Befehle.
Tech Stack
Keine
Domain
developer experience
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.
Frisch
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.
90