JuliaDocs/Documenter.jl

Add a note to contributor docs about how to format code

Open

#2,528 opened on 2024年6月14日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Julia (910 stars) (513 forks)batch import
Type: Documentationgood first issue

説明

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

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

コントリビューターガイド

技術スタック
javascript
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
Markdowncontributor guide
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85
調査方針
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.