akka/akka-core

Consistent doc header casing

开放

#27,741 创建于 2019年9月18日

在 GitHub 查看贡献者指南
 (5 条评论) (0 个反应) (0 位负责人)Scala (3,547 个派生)batch import
1 - triagedhelp wantednice-to-have (low-prio)t:docs

仓库指标

星标
 (13,277 个星标)
PR 合并指标
 (平均合并 8天 19小时) (30 天内合并 10 个 PR)

描述

Noted in https://github.com/akka/akka/pull/27708#discussion_r325227829 that our uppercasing in headers is all over the place, we should pick one strategy and stick with it.

My suggestion, Title Capitalization For The Page Title (h1) and Normal capitalization for the subheaders. (I have no writing practice knowledge to motivate it with though)

贡献者指南

研究方向
识别所有文档标题，并应用选定的大小写策略：页面标题（h1）使用标题大小写，子标题使用常规句子大小写。
技术栈
scala
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85