JuliaDocs/Documenter.jl

Add a note to contributor docs about how to format code

Open

#2 528 ouverte le 14 juin 2024

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Julia (910 stars) (513 forks)batch import
Type: Documentationgood first issue

Description

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

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

Guide contributeur

Stack technique
javascript
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Markdowncontributor guide
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85
Direction de recherche
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.