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 (513 forks)batch import
Type: Documentationgood first issue

Métriques du dépôt

Stars
 (910 stars)
Métriques de merge PR
 (Merge moyen 16j 9h) (3 PRs mergées en 30 j)

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

Direction de recherche
Vérifiez la documentation existante pour les contributeurs dans le dépôt, probablement dans un fichier CONTRIBUTING.md ou le dossier docs. Consultez le commentaire de PR lié (https://github.com/JuliaDocs/Documenter.jl/pull/2514#issuecomment 2165219642) pour le contexte sur les outils de formatage mentionnés. Ajoutez une note faisant référence à l'utilisation de Prettier pour les fichiers JavaScript et au plan futur d'utilisation de JuliaFormatter pour le code Julia (issue #2404). La note doit être concise et placée dans la section pertinente de la documentation pour les contributeurs.
Stack technique
Aucun
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.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90