Standardisation of sphinx docs page titles
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 25/100
- Issue 類型
- 文件
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
研究方向
先查看 https://diamondlightsource.github.io/python-copier-template/main/how-to.html 上的範例頁面和 issue 討論，因為沒有指定來源檔案或測試。在界定檢查範圍之前，確認專案已就標題慣例達成共識，並找出文件建置的進入點；完成的標準是該慣例已明確規定，且建置始終強制執行該慣例。
由索引模型根據 Issue 內容生成。
描述
This may be the nitpickiest issue I have ever raised, so should not be actioned unless there's strong agreement.
(from https://diamondlightsource.github.io/python-copier-template/main/how-to.html)
It annoys me that the titles for docs pages are not really standardised, Some Are Capitalised, some are not, some are prefixed with "How to" or similar. If there is a really easy check that can be added to the docs builds it might add a layer of consistency and professionalism. The hardest part, as ever when we talk about formatting, may be agreeing on which standard to use.
- 主要語言
- Jinja
- 星號
- 25
- 分支
- 9
- 平均合併
- 4 小時 36 分鐘
- 30 天內合併 PR
- 4
環境準備
在瀏覽器裡用你自己的 GitHub 帳號啟動這個專案的開發容器。
- 提供 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
DiamondLightSource/python-copier-template 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 68/100
-
難度 2/5 1-3 小時 新手友好度 72/100
-
難度 1/5 1 小時以內 新手友好度 68/100
-
documentation good first issue
難度 1/5 1 小時以內 新手友好度 70/100
-
難度 2/5 1-3 小時 新手友好度 68/100
查看 DiamondLightSource/python-copier-template 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 78/100
JoviDeCroock/pracht#432 ·
維護者通常 1 天內回覆
-
fix(ci): check-changed-skills.sh fails a stale branch on skills only main changed可能已有人在做 關聯的 PR 仍在進行中或已合併。 未關閉good first issue needs-triage priority: medium
難度 2/5 1-3 小時 新手友好度 72/100
melodic-software/claude-code-plugins#7014 · 1 則留言 ·
維護者通常 1 天內回覆
-
[Bug]: atlauncher fails to install due to invalid requires (libpulseaudio, libudev)可能已有人在做 @Owen-sz 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 84/100
維護者通常 1 天內回覆
-
chore(build): TxCoordinator.cpp uses the deprecated shared_ptr atomic free functions可能已有人在做 @w5jwp 今天認領。 未關閉
難度 1/5 1 小時以內 新手友好度 84/100
aethersdr/AetherSDR#6368 · 1 則留言 ·
維護者通常 1 天內回覆
-
Typings import `react` and `react-dom`, but `@types/react` and `@types/react-dom` are not declared as peer dependencies可能已有人在做 @lazerg 今天認領。 未關閉react
難度 2/5 1-3 小時 新手友好度 78/100
維護者通常 1 天內回覆