mapbox / mapbox/node-cpp-skel

Improving code formatting docs with additional efficiency recommendations

オープン
#97 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

.clang-format、make format、Travis のフォーマットチェックを扱っているドキュメントを見つけてください。リンクされている pre-commit hook のリファレンスとエディター統合の動画を確認し、両方のワークフローについて推奨事項を追加してください。開発者がフォーマット用フックの設定方法と、一般的なエディターで Mason がインストールした clang-format を使用するための設定方法を、実行可能な手順として見つけられるようになれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
cpp
領域
documentation, tooling
issue の種類
ドキュメント
難易度
2/5
見積もり時間
半日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。