How do we want to document clang-tidy and clang-format config options?
未关闭
还没有人认领这个 Issue。
- 主要语言
- C++
- 星标
- 74
- 派生
- 9
- PR 合并指标
- 30 天内没有已合并 PR
描述
Would it be useful to add documentation in the config files about different clang-tidy options for example? Or would we rather document in a readme?
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
首先定位仓库中的 clang-tidy 和 clang-format 配置文件以及任何 README 文档。比较可用于解释配置选项的位置，然后明确哪些选项需要覆盖，以及文档应放在配置文件中还是 README 中。项目确定了一个一致同意的文档位置，并且相关选项已在该位置完成文档说明，即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- cpp
- 领域
- documentation, tooling
- Issue 类型
- 文档
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 20/100