JuliaDocs/Documenter.jl

Add a note to contributor docs about how to format code

Offen

#2.528 geöffnet am 14.06.2024

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Julia (513 Forks)batch import
Type: Documentationgood first issue

Repository-Metriken

Stars
 (910 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 16T 9h) (3 gemergte PRs in 30 T)

Beschreibung

https://github.com/JuliaDocs/Documenter.jl/pull/2514#issuecomment-2165219642

We use prettier for js, and also JuliaFormatter as some point hopefully (#2404).

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandene Mitwirkenden Dokumentation im Repository, wahrscheinlich in einer CONTRIBUTING.md oder im docs Ordner. Sehen Sie sich den verlinkten PR Kommentar (https://github.com/JuliaDocs/Documenter.jl/pull/2514#issuecomment 2165219642) für den Kontext zu den erwähnten Formatierungstools an. Fügen Sie einen Hinweis hinzu, der sich auf die Verwendung von Prettier für JavaScript Dateien und den zukünftigen Plan bezieht, JuliaFormatter für Julia Code zu verwenden (Issue #2404). Der Hinweis sollte prägnant sein und im relevanten Abschnitt der Mitwirkenden Dokumentation platziert werden.
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.
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.
90