mapbox / mapbox/node-cpp-skel

Improving code formatting docs with additional efficiency recommendations

未关闭
#97 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

help wanted
主要语言
C++
星标
74
派生
9
PR 合并指标
30 天内没有已合并 PR

描述

node-cpp-skel has support for:

  • a .clang-format style file that provides formatting rules (which can be modified/customized)
  • make format an 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:

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

找到涵盖 .clang-format、make format 和 Travis 格式检查的文档。查看链接的 pre-commit hook 参考资料和编辑器集成视频,然后为这两种工作流添加建议。当开发者能够找到有关设置格式化 hook 以及配置常用编辑器以使用 Mason 安装的 clang-format 的可操作指南时,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
cpp
领域
documentation, tooling
Issue 类型
文档
难度
2/5
预计耗时
半天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。