JuliaDocs/Documenter.jl

Add a note to contributor docs about how to format code

Open

#2,528 opened on Jun 14, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)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).

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Markdowncontributor guide
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
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.