Improving code formatting docs with additional efficiency recommendations
未关闭
还没有人认领这个 Issue。
help wanted
- 主要语言
- C++
- 星标
- 74
- 派生
- 9
- PR 合并指标
- 30 天内没有已合并 PR
描述
node-cpp-skel has support for:
- a
.clang-formatstyle file that provides formatting rules (which can be modified/customized) make formatan easy command to run to consistently format all the code (and ensure a consistent version of clang-format is available)- a travis job that runs a check to catch when you've forgotten to format your code and in contains incorrectly formatted code (uses same clang-format version as is used locally by
make format)
We can improve by adding docs/recommendations for developers for how to:
- add a git commit hook to ensure code is formatted (before pushing) - refs http://www.duskborn.com/git-pre-commit-clang-format-hook/
- integrate the mason installed clang-format with common text editors such that formatting happens during coding (like seen in https://youtu.be/uZI_Qla4pNA?t=1904)
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
找到涵盖 .clang-format、make format 和 Travis 格式检查的文档。查看链接的 pre-commit hook 参考资料和编辑器集成视频,然后为这两种工作流添加建议。当开发者能够找到有关设置格式化 hook 以及配置常用编辑器以使用 Mason 安装的 clang-format 的可操作指南时,即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- cpp
- 领域
- documentation, tooling
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 半天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100