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

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (Avg merge 16d 9h) (3 merged PRs in 30d)

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

Research direction
Add a note to contributor docs explaining code formatting standards, referencing prettier for JavaScript and JuliaFormatter for Julia.
Tech stack
None
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90