JuliaDocs/Documenter.jl

Add a note to contributor docs about how to format code

Open

#2.528 geöffnet am 14. Juni 2024

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

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

Tech Stack
javascript
Domain
documentation
Issue Type
documentation
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.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Markdowncontributor guide
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85
Research-Richtung
Check the existing contributor documentation in the repository, likely in a CONTRIBUTING.md or docs folder. Look at the linked PR comment (https://github.com/JuliaDocs/Documenter.jl/pull/2514#issuecomment 2165219642) for context on the formatting tools mentioned. Add a note referencing the use of Prettier for JavaScript files and the future plan to use JuliaFormatter for Julia code (issue #2404). The note should be concise and placed in the relevant section of the contributor docs.